improve README
| 1 files changed, 19 insertions(+), 9 deletions(-) | |||
|---|---|---|---|
| M | README | +19 | -9 |
1@@ -28,25 +28,26 @@ Dependencies
2 ------------
3
4 - libgit2 (v0.22+).
5-- C compiler
6+- libc (tested with OpenBSD, glibc and musl).
7+- C compiler (C99).
8 - make
9
10
11 Documentation
12 -------------
13
14-$ man stagit
15-$ man stagit-index
16+See man pages: stagit(1) and stagit-index(1).
17
18
19 Features
20 --------
21
22-- Log of all commits.
23+- Log of all commits from HEAD.
24 - Log and diffstat per commit.
25 - Show file tree with linkable line numbers.
26+- Show references: local branches and tags.
27 - Detect README and LICENSE file from HEAD and link it as a webpage.
28-- Atom feed log.
29+- Atom feed log (atom.xml).
30 - Make index page for multiple repositories with stagit-index.
31 - After generating the pages (relatively slow) serving the files is very fast,
32 simple and requires little resources (because the content is static), only
33@@ -56,7 +57,16 @@ Features
34 Cons
35 ----
36
37-- Not suitable for large repositories (2000+ commits).
38-- Not suitable for repositories with many branches, a quite linear history is assumed.
39-- Relatively slow to run the first time (about 3 seconds for sbase, 1500+ commits),
40- incremental updates after it are faster.
41+- Not suitable for large repositories (2000+ commits), because diffstats are
42+ an expensive operation.
43+- Not suitable for repositories with many branches, a quite linear history is
44+ assumed (from HEAD).
45+- Relatively slow to run the first time (about 3 seconds for sbase,
46+ 1500+ commits), incremental updates after it are faster.
47+- Does not support some of the dynamic features cgit has, like:
48+ - snapshot tarballs.
49+ - file tree per commit.
50+ - history log of branches diverged from HEAD.
51+ - stats (git shortlog -s).
52+
53+ this is by design, just use git locally.