X-Git-Url: https://git.armaanb.net/?p=stagit.git;a=blobdiff_plain;f=README;h=3c5d3c3964e62a4ee930c2b30dc8f0951e78f95e;hp=6354725d21504e3b56b64d4c611859b12aea23c7;hb=b0d3a4f50b346f540db0fd3f20c30bd78344eb2a;hpb=20c37e4fe4bfef13642542f3fa15aa73c92a037c diff --git a/README b/README index 6354725..3c5d3c3 100644 --- a/README +++ b/README @@ -1,8 +1,10 @@ stagit -====== +------ -static git page generator +static git page generator. personal fork with syntax highlighting and some +quality of life improvements +It generates static HTML pages for a git repository. Usage ----- @@ -17,8 +19,8 @@ Make index file for repositories: $ stagit-index repodir1 repodir2 repodir3 > index.html -Install -------- +Build and install +----------------- $ make # make install @@ -27,10 +29,11 @@ $ make Dependencies ------------ -- libgit2 (v0.22+). -- libc (tested with OpenBSD, FreeBSD, Linux: glibc and musl). - C compiler (C99). -- make +- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl). +- libgit2 (v0.22+). +- POSIX make (optional). +- Python3, pip. Documentation