aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 9a023acd13a714c3b5404d2e6d015e9138b8fd71 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
stagit
======

static git page generator


Usage
-----

Make files per repository:

	$ mkdir -p htmldir && cd htmldir
	$ stagit path-to-repo

Make index file for repositories:

	$ stagit-index repodir1 repodir2 repodir3 > index.html


Install
-------

$ make
# doas make install


Dependencies
------------

- libgit2 (v0.22+).
- C compiler
- make


Documentation
-------------

$ man stagit
$ man stagit-index


Features
--------

- Log of all commits.
- Log and diffstat per commit.
- Show file tree with linkable line numbers.
- Detect README and LICENSE file from HEAD and link it as a webpage.
- Atom feed log.
- Make index page for multiple repositories with stagit-index.
- After generating the pages (relatively slow) serving the files is very fast,
  simple and requires little resources (because the content is static), only
  a HTTP file server is required.


Cons
----

- Not suitable for large repositories (2000+ commits).
- Not suitable for repositories with many branches, a quite linear history is assumed.
- Relatively slow to run the first time (about 3 seconds for sbase, 1500+ commits),
  incremental updates after it are faster.