ui-tree: allow per repository override for enable-blame

[cgit.git] / README

diff --git a/README b/README
index a14418e8db8af0e239b524a0f37505e94f9993ba..7a6b4a40ca571d1f209cfce38b1e1125bb8346be 100644 (file)
--- a/README
+++ b/README
@@ -1,55 +1,99 @@
+cgit - CGI for Git
+==================

 
 

-                       cgit - cgi for git
+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.

 
 

+Installation
+------------

 
 

-This is an attempt to create a fast web interface for the git scm, using a
-builtin cache to decrease server io-pressure.
+Building cgit involves building a proper version of Git. How to do this
+depends on how you obtained the cgit sources:

 
 

+a) If you're working in a cloned cgit repository, you first need to
+initialize and update the Git submodule:

 
 

-Installation
+    $ git submodule init     # register the Git submodule in .git/config
+    $ $EDITOR .git/config    # if you want to specify a different url for git
+    $ git submodule update   # clone/fetch and checkout correct git version

 
 

-  $ make gitsrc=<path>
-  $ su
-  $ make prefix=<path> install
+b) If you're building from a cgit tarball, you can download a proper git
+version like this:

 
 

+    $ make get-git

 
 

-Default value for gitsrc is "../git", and this directory should contain the
-git sources.
+When either a) or b) has been performed, you can build and install cgit like
+this:

 
 

-Default value for prefix is "/var/www/htdocs/cgit". This directory will 
-contain "cgit.cgi" and "cgit.css" after 'make install'.
+    $ make
+    $ sudo make install

 
 

-After installation, httpd.conf probably must be updated with a Directory-
-section for cgit, possibly something like this:
+This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
+can configure this location (and a few other things) by providing a `cgit.conf`
+file (see the Makefile for details).

 
 

-  <Directory "/var/www/htdocs/cgit/">
-      AllowOverride None
-      Options ExecCGI
-      Order allow,deny
-      Allow from all
-  </Directory>
+If you'd like to compile without Lua support, you may use:

 
 

+    $ make NO_LUA=1

 
 

-Runtime configuration
+And if you'd like to specify a Lua implementation, you may use:
+
+    $ make LUA_PKGCONFIG=lua5.1
+
+If this is not specified, the Lua implementation will be auto-detected,
+preferring LuaJIT if many are present. Acceptable values are generally "lua",
+"luajit", "lua5.1", and "lua5.2".
+
+
+Dependencies
+------------
+
+* libzip
+* libcrypto (OpenSSL)
+* libssl (OpenSSL)
+* optional: luajit or lua, most reliably used when pkg-config is available

 
 

-The file /etc/cgitrc is read by cgit before handling a request. In addition
-to runtime parameters, this file also contains a list of the repositories 
-displayed by cgit.
+Apache configuration
+--------------------

 
 

-A template cgitrc is shipped with the sources, and all parameters and default
-values are documented in this file. 
+A new `Directory` section must probably be added for cgit, possibly something
+like this:

 
 

+    <Directory "/var/www/htdocs/cgit/">
+        AllowOverride None
+        Options +ExecCGI
+        Order allow,deny
+        Allow from all
+    </Directory>
+
+
+Runtime configuration
+---------------------
+
+The file `/etc/cgitrc` is read by cgit before handling a request. In addition
+to runtime parameters, this file may also contain a list of repositories
+displayed by cgit (see `cgitrc.5.txt` for further details).

 
 The cache
 
 The cache

+---------

 
 

-When cgit is invoked it looks for a cachefile matching the request and 
-returns it to the client. If no such cachefile exist (or if it has expired), 
-the content for the request is written into the proper cachefile before the
+When cgit is invoked it looks for a cache file matching the request and
+returns it to the client. If no such cache file exists (or if it has expired),
+the content for the request is written into the proper cache file before the

 file is returned.
 
 file is returned.
 

-If the cachefile has expired but cgit is unable to obtain a lock for it, the 
-stale cachefile is returned to the client. This is done to favour page
+If the cache file has expired but cgit is unable to obtain a lock for it, the
+stale cache file is returned to the client. This is done to favour page

 throughput over page freshness.
 
 The generated content contains the complete response to the client, including
 throughput over page freshness.
 
 The generated content contains the complete response to the client, including

-the http-headers "Modified" and "Expires".
+the HTTP headers `Modified` and `Expires`.
+
+Online presence
+---------------
+
+* The cgit homepage is hosted by cgit at <https://git.zx2c4.com/cgit/about/>
+
+* Patches, bug reports, discussions and support should go to the cgit
+  mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
+  <https://lists.zx2c4.com/mailman/listinfo/cgit>