iimprove README - stagit-gopher - A git gopher frontend. (mirror) Err bitreich.org 70 hgit clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/ URL:git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/ bitreich.org 70 1Log /scm/stagit-gopher/log.gph bitreich.org 70 1Files /scm/stagit-gopher/files.gph bitreich.org 70 1Refs /scm/stagit-gopher/refs.gph bitreich.org 70 1Tags /scm/stagit-gopher/tag bitreich.org 70 1README /scm/stagit-gopher/file/README.gph bitreich.org 70 1LICENSE /scm/stagit-gopher/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 1commit c226554b64a9529296b690d827966ccf139336bd /scm/stagit-gopher/commit/c226554b64a9529296b690d827966ccf139336bd.gph bitreich.org 70 1parent ef3f1ef854936fc254da5375f69f58dad4e69ca6 /scm/stagit-gopher/commit/ef3f1ef854936fc254da5375f69f58dad4e69ca6.gph bitreich.org 70 hAuthor: Hiltjo Posthuma URL:mailto:hiltjo@codemadness.org bitreich.org 70 iDate: Sun, 27 Dec 2015 19:05:45 +0100 Err bitreich.org 70 i Err bitreich.org 70 iimprove README Err bitreich.org 70 i Err bitreich.org 70 iDiffstat: Err bitreich.org 70 i M README | 46 ++++++++++++++++++++++++++----- Err bitreich.org 70 i M example.sh | 2 +- Err bitreich.org 70 i Err bitreich.org 70 i2 files changed, 40 insertions(+), 8 deletions(-) Err bitreich.org 70 i--- Err bitreich.org 70 1diff --git a/README b/README /scm/stagit-gopher/file/README.gph bitreich.org 70 i@@ -1,30 +1,62 @@ Err bitreich.org 70 i+stagit Err bitreich.org 70 i+====== Err bitreich.org 70 i+ Err bitreich.org 70 i+static git page generator Err bitreich.org 70 i+ Err bitreich.org 70 i Err bitreich.org 70 i Usage Err bitreich.org 70 i ----- Err bitreich.org 70 i Err bitreich.org 70 i-mkdir -p htmldir Err bitreich.org 70 i-cd htmldir Err bitreich.org 70 i-stagit path-to-repo Err bitreich.org 70 i+Make files per repository: Err bitreich.org 70 i+ Err bitreich.org 70 i+ $ mkdir -p htmldir && cd htmldir Err bitreich.org 70 i+ $ stagit path-to-repo Err bitreich.org 70 i+ Err bitreich.org 70 i+Make index file for repositories: Err bitreich.org 70 i+ Err bitreich.org 70 i+ $ stagit-index repodir1 repodir2 repodir3 > index.html Err bitreich.org 70 i Err bitreich.org 70 i Err bitreich.org 70 i Install Err bitreich.org 70 i ------- Err bitreich.org 70 i+ Err bitreich.org 70 i $ make Err bitreich.org 70 i # doas make install Err bitreich.org 70 i Err bitreich.org 70 i Err bitreich.org 70 i Dependencies Err bitreich.org 70 i ------------ Err bitreich.org 70 i+ Err bitreich.org 70 i - libgit2 (v0.22+). Err bitreich.org 70 i - C compiler Err bitreich.org 70 i - make Err bitreich.org 70 i Err bitreich.org 70 i Err bitreich.org 70 i+Documentation Err bitreich.org 70 i+------------- Err bitreich.org 70 i+ Err bitreich.org 70 i+$ man stagit Err bitreich.org 70 i+$ man stagit-index Err bitreich.org 70 i+ Err bitreich.org 70 i+ Err bitreich.org 70 i Features Err bitreich.org 70 i -------- Err bitreich.org 70 i Err bitreich.org 70 i+- Log of all commits. Err bitreich.org 70 i - Log and diffstat per commit. Err bitreich.org 70 i-- Show file tree. Err bitreich.org 70 i-- Detect README and LICENSE file to make a webpage. Err bitreich.org 70 i-- Atom feed git log. Err bitreich.org 70 i-- Make index page for multiple repositories. Err bitreich.org 70 i+- Show file tree with linkable line numbers. Err bitreich.org 70 i+- Detect README and LICENSE file from HEAD and link it as a webpage. Err bitreich.org 70 i+- Atom feed log. Err bitreich.org 70 i+- Make index page for multiple repositories with stagit-index. Err bitreich.org 70 i+- After generating the pages (relatively slow) serving the files is very fast, Err bitreich.org 70 i+ simple and requires little resources (because the content is static), only Err bitreich.org 70 i+ a HTTP file server is required. Err bitreich.org 70 i+ Err bitreich.org 70 i+ Err bitreich.org 70 i+Cons Err bitreich.org 70 i+---- Err bitreich.org 70 i+ Err bitreich.org 70 i+- Not suitable for large repositories (2000+ commits). Err bitreich.org 70 i+- Not suitable for repositories with many branches, a quite linear history is assumed. Err bitreich.org 70 i+- Relatively slow to run the first time (about 3 seconds for sbase, 1500+ commits), Err bitreich.org 70 i+ incremental updates after it are faster. Err bitreich.org 70 1diff --git a/example.sh b/example.sh /scm/stagit-gopher/file/example.sh.gph bitreich.org 70 i@@ -10,7 +10,7 @@ Err bitreich.org 70 i # Err bitreich.org 70 i # Usage: Err bitreich.org 70 i # - mkdir -p htmldir && cd htmldir Err bitreich.org 70 i-# - sh example.sh repo-dir Err bitreich.org 70 i+# - sh example.sh Err bitreich.org 70 i Err bitreich.org 70 i set -e Err bitreich.org 70 i Err bitreich.org 70 .