- Commit
- fcee797ae625e6a4df71039a0251c0aeabc97ce1
- Parent
- 0324caf04db9198a9c4c70a96a43c94bf428de08
- Author
- Pablo <pablo-pie@riseup.net>
- Date
Added install instructions to README
yagit
Yet another static site generator for Git 🙀️
Diffstats
1 files changed, 14 insertions, 0 deletions
| Status | Name | Changes | Insertions | Deletions |
| Modified | README.md | 2 files changed | 14 | 0 |
diff --git a/README.md b/README.md @@ -44,3 +44,17 @@ $ yagit render-batch BATCH_PATH OUTPUT_PATH yagit will generate the HTML pages for `BATCH_PATH/REPO_NAME` at `OUTPUT_PATH/REPO_NAME`, as well as an index of all git repositories in `BATCH_PATH` at `OUTPUT_PATH/index.html`. + +## Installation + +yagit can be installed via Cargo by cloning this repository, as in: + +```console +$ git clone git://git.pablopie.xyz/yagit +$ cargo install --path ./yagit +``` + +### Build Dependencies + +* [libgit2](https://libgit2.org) +* [libssl](https://www.openssl-library.org)