Render .md files with cmark-gfm

[stagit.git] / README

diff --git a/README b/README
index a8384e429be662486848b5f0051709fd9b11e1c2..a411c497624436f2735cebab869d9e17d0d37fd0 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,11 @@
 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
 -----
 
@@ -16,7 +16,7 @@ Make files per repository:
 
 Make index file for repositories:
 
-       $ stagit-index repodir1 repodir2 repodir3 > index.html
+       $ stagit-index repodir1 repodir2 repodir3
 
 
 Build and install
@@ -32,6 +32,8 @@ Dependencies
 - C compiler (C99).
 - libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
 - libgit2 (v0.22+).
+- Chroma
+- cmark-gfm
 - POSIX make (optional).