Map the source tree in the README

1 file changed, 15 insertions, 0 deletions

diff --git a/README.txt b/README.txtindex e36fd42..f8b0f5c 100644--- a/README.txt+++ b/README.txt@@ -5,6 +5,21 @@ This is an attempt to create a fast web interface for the Git SCM, using a built-in cache to decrease server I/O pressure.  +Source tree+-----------++* source/ is the C code, built inside the Git tree in vendor/git, and assets/+  holds the static files make install copies.+* custom/ holds the reference cgitrc, the web server configs in servers/, the+  Lua filters in extensions/ and in hooks/ standalone post-receive hooks that+  keep the idle column, the cache and the commit-graph current.+* tools/ holds build-release.sh for a hardened build, without Lua unless given+  lua, build-development.sh for a debug build with sanitizers, and serve.py,+  which previews the built binary on a local port and needs a cgitrc, ./cgitrc+  unless --config names another.+* tests/ is the suite make test runs.++ Installation ------------ 
diff --git a/README.txt b/README.txt
index e36fd42..f8b0f5c 100644
--- a/README.txt
+++ b/README.txt
@@ -5,6 +5,21 @@ This is an attempt to create a fast web interface for the Git SCM, using a
 built-in cache to decrease server I/O pressure.
 
 
+Source tree
+-----------
+
+* source/ is the C code, built inside the Git tree in vendor/git, and assets/
+  holds the static files make install copies.
+* custom/ holds the reference cgitrc, the web server configs in servers/, the
+  Lua filters in extensions/ and in hooks/ standalone post-receive hooks that
+  keep the idle column, the cache and the commit-graph current.
+* tools/ holds build-release.sh for a hardened build, without Lua unless given
+  lua, build-development.sh for a debug build with sanitizers, and serve.py,
+  which previews the built binary on a local port and needs a cgitrc, ./cgitrc
+  unless --config names another.
+* tests/ is the suite make test runs.
+
+
 Installation
 ------------