stagit

improve README

 1@@ -1,30 +1,62 @@
 2+stagit
 3+======
 4+
 5+static git page generator
 6+
 7 
 8 Usage
 9 -----
10 
11-mkdir -p htmldir
12-cd htmldir
13-stagit path-to-repo
14+Make files per repository:
15+
16+	$ mkdir -p htmldir && cd htmldir
17+	$ stagit path-to-repo
18+
19+Make index file for repositories:
20+
21+	$ stagit-index repodir1 repodir2 repodir3 > index.html
22 
23 
24 Install
25 -------
26+
27 $ make
28 # doas make install
29 
30 
31 Dependencies
32 ------------
33+
34 - libgit2 (v0.22+).
35 - C compiler
36 - make
37 
38 
39+Documentation
40+-------------
41+
42+$ man stagit
43+$ man stagit-index
44+
45+
46 Features
47 --------
48 
49+- Log of all commits.
50 - Log and diffstat per commit.
51-- Show file tree.
52-- Detect README and LICENSE file to make a webpage.
53-- Atom feed git log.
54-- Make index page for multiple repositories.
55+- Show file tree with linkable line numbers.
56+- Detect README and LICENSE file from HEAD and link it as a webpage.
57+- Atom feed log.
58+- Make index page for multiple repositories with stagit-index.
59+- After generating the pages (relatively slow) serving the files is very fast,
60+  simple and requires little resources (because the content is static), only
61+  a HTTP file server is required.
62+
63+
64+Cons
65+----
66+
67+- Not suitable for large repositories (2000+ commits).
68+- Not suitable for repositories with many branches, a quite linear history is assumed.
69+- Relatively slow to run the first time (about 3 seconds for sbase, 1500+ commits),
70+  incremental updates after it are faster.

1@@ -10,7 +10,7 @@
2 #
3 # Usage:
4 # - mkdir -p htmldir && cd htmldir
5-# - sh example.sh repo-dir
6+# - sh example.sh
7 
8 set -e
9