Skip to content

Commit e7bc75c

Browse files
committed
Update README
1 parent 6e1abbd commit e7bc75c

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,41 @@ a unified interface describing heterogeneous build jobs.
1313
Hosted [here](https://awslabs.github.io/aws-build-accumulator/).
1414

1515

16-
### Requirements
16+
### Installation
1717

18-
* Python 3
18+
To install with [Homebrew](https://brew.sh):
19+
20+
```bash
21+
brew tap aws/tap
22+
brew install litani
23+
```
24+
25+
Documentation can also be accessed using `man`:
26+
27+
```bash
28+
man litani
29+
```
30+
31+
### Dependencies
32+
33+
If you are cloning the source code, you will need the following dependencies:
34+
35+
#### Required
36+
37+
* Python3
1938
* [Ninja](https://ninja-build.org/)
2039
* `apt-get install ninja-build`, `brew install ninja`
2140
* [Jinja](https://jinja.palletsprojects.com/en/2.11.x/)
2241
* `pip3 install jinja2`
23-
* [Graphviz DOT](https://graphviz.org/)
24-
* `apt-get install graphviz`, `brew install graphviz`
2542

26-
Recommended:
43+
#### Recommended
2744

45+
* [Graphviz DOT](https://graphviz.org/)
46+
* `apt-get install graphviz`, `brew install graphviz`
2847
* [Gnuplot](http://www.gnuplot.info/) to generate graphs on the dashboard
2948
* `apt-get install gnuplot`, `brew install gnuplot`
3049

31-
Optional:
50+
#### Optional
3251

3352
* [Voluptuous](https://pypi.org/project/voluptuous/) to perform
3453
sanity-checking on internal data structures

0 commit comments

Comments
 (0)