]> git.armaanb.net Git - stagit.git/commitdiff
some README tweaks and rewording, reordering
authorHiltjo Posthuma <hiltjo@codemadness.org>
Sun, 1 Dec 2019 17:26:27 +0000 (18:26 +0100)
committerHiltjo Posthuma <hiltjo@codemadness.org>
Sun, 1 Dec 2019 17:26:27 +0000 (18:26 +0100)
README

diff --git a/README b/README
index 8076ae8777de42707b37d0390aa8e3f5148e9b3a..a8384e429be662486848b5f0051709fd9b11e1c2 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,9 @@
 stagit
-======
+------
 
-static git page generator
+static git page generator.
+
+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,10 @@ $ make
 Dependencies
 ------------
 
-- libgit2 (v0.22+).
-- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
 - C compiler (C99).
-- make
+- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
+- libgit2 (v0.22+).
+- POSIX make (optional).
 
 
 Documentation