commit b5607f75afb9c6e6e6ab49128f9760d3538809cd
parent adaff713dc3e9ff494632a44d5743cbc0e0e16c7
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sun, 1 Dec 2019 18:26:27 +0100
some README tweaks and rewording, reordering
Diffstat:
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git 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
