README

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