X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README;h=a411c497624436f2735cebab869d9e17d0d37fd0;hb=bf62b511ebf4be03e07a0f2aa4d01bf0289ca8b0;hp=6354725d21504e3b56b64d4c611859b12aea23c7;hpb=20c37e4fe4bfef13642542f3fa15aa73c92a037c;p=stagit.git

diff --git a/README b/README
index 6354725..a411c49 100644
--- a/README
+++ b/README
@@ -1,8 +1,10 @@
 stagit
-======
+------
 
-static git page generator
+static git page generator. personal fork with fast syntax highlighting via
+Chroma and some style and quality of life improvements.
 
+It generates static HTML pages for a git repository.
 
 Usage
 -----
@@ -14,11 +16,11 @@ Make files per repository:
 
 Make index file for repositories:
 
-	$ stagit-index repodir1 repodir2 repodir3 > index.html
+	$ stagit-index repodir1 repodir2 repodir3
 
 
-Install
--------
+Build and install
+-----------------
 
 $ make
 # make install
@@ -27,10 +29,12 @@ $ 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+).
+- Chroma
+- cmark-gfm
+- POSIX make (optional).
 
 
 Documentation