stagit-index: remove Content-Language: en

[stagit.git] / README

diff --git a/README b/README
index fc81a38b22caf1cc856d6675ae9e4989babf11f4..10f1884bfd1d348cfd6472bcb2aff79d27fc9744 100644 (file)
--- a/README
+++ b/README
@@ -21,7 +21,7 @@ Install
 -------
 
 $ make
-# doas make install
+# make install
 
 
 Dependencies
@@ -39,6 +39,28 @@ Documentation
 See man pages: stagit(1) and stagit-index(1).
 
 
+Building a static binary
+------------------------
+
+It may be useful to build static binaries, for example to run in a chroot.
+
+It can be done like this at the time of writing (v0.24):
+
+cd libgit2-src
+
+# change the options in the CMake file: CMakeLists.txt
+BUILD_SHARED_LIBS to OFF (static)
+CURL to OFF              (not needed)
+USE_SSH OFF              (not needed)
+THREADSAFE OFF           (not needed)
+USE_OPENSSL OFF          (not needed, use builtin)
+
+mkdir -p build && cd build
+cmake ../
+make
+make install
+
+
 Features
 --------
 
@@ -47,11 +69,13 @@ Features
 - Show file tree with linkable line numbers.
 - Show references: local branches and tags.
 - Detect README and LICENSE file from HEAD and link it as a webpage.
+- Detect submodules (.gitmodules file) from HEAD and link it as a webpage.
 - Atom feed log (atom.xml).
 - 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.
+- Usable with text-browsers such as dillo, links, lynx and w3m.
 
 
 Cons