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 - libc (tested with OpenBSD, FreeBSD, glibc and musl).
  32 - C compiler (C99).
  33 - make
  34
  35
  36 Documentation
  37 -------------
  38
  39 See man pages: stagit(1) and stagit-index(1).
  40
  41
  42 Features
  43 --------
  44
  45 - Log of all commits from HEAD.
  46 - Log and diffstat per commit.
  47 - Show file tree with linkable line numbers.
  48 - Show references: local branches and tags.
  49 - Detect README and LICENSE file from HEAD and link it as a webpage.
  50 - Atom feed log (atom.xml).
  51 - Make index page for multiple repositories with stagit-index.
  52 - After generating the pages (relatively slow) serving the files is very fast,
  53   simple and requires little resources (because the content is static), only
  54   a HTTP file server is required.
  55
  56
  57 Cons
  58 ----
  59
  60 - Not suitable for large repositories (2000+ commits), because diffstats are
  61   an expensive operation.
  62 - Not suitable for repositories with many branches, a quite linear history is
  63   assumed (from HEAD).
  64 - Relatively slow to run the first time (about 3 seconds for sbase,
  65   1500+ commits), incremental updates after it are faster.
  66 - Does not support some of the dynamic features cgit has, like:
  67   - snapshot tarballs.
  68   - file tree per commit.
  69   - history log of branches diverged from HEAD.
  70   - stats (git shortlog -s).
  71
  72   this is by design, just use git locally.