X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/5a217ed3e04a6ef7b066ded446582c0dd0fc5d3e..da218fcd9eb554a8405ca72e84bcc0feb371194f:/README

diff --git a/README b/README
index 6d661d8..e1d5262 100644
--- a/README
+++ b/README
@@ -1,81 +1,85 @@
+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:
 
-Installation
+a) If you're working in a cloned cgit repository, you first need to
+initialize and update the Git submodule:
 
-  $ make
-  $ su
-  $ make install
+    $ 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
 
-This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".
+b) If you're building from a cgit tarball, you can download a proper git
+version like this:
 
-Note: The initial "make" will create a submodule 'git' and clone the git
-repository at git://git.kernel.org/pub/scm/git/git.git in it. If you
-already have a local git git repository that you want to use as origin
-for the submodule, run
+    $ make get-git
 
-  $ git clone -s <path-to-git-repo> git
-  $ ./submodules.sh -u
+When either a) or b) has been performed, you can build and install cgit like
+this:
 
-before running "make".
+    $ make
+    $ sudo make install
 
+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).
 
 Dependencies
+------------
 
-  -git (1.5.2-rc0 or newer, due to git submodule) installed
-  -zip lib
-  -crypto lib
-  -openssl lib
-
+* libzip
+* libcrypto (OpenSSL)
+* libssl (OpenSSL)
 
 Apache configuration
+--------------------
 
-A new Directory-section must probably be added for cgit, possibly something
+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>
+    <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 also contains a list of the repositories
-displayed by cgit.
-
-A template cgitrc is shipped with the sources, and all parameters and default
-values are documented in this file.
-
+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
+---------
 
-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.
 
-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
-the http-headers "Modified" and "Expires".
-
-
-The mis(sing) features
+the HTTP headers `Modified` and `Expires`.
 
-Submodule links in the directory listing page have a fixed format per
-repository. This should probably be extended to a generic map between
-submodule path and url.
+Online presence
+---------------
 
+* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
 
-The end.
+* Patches, bug reports, discussions and support should go to the cgit
+  mailing list: <cgit@lists.zx2c4.com>. To sign up, visit 
+  <http://lists.zx2c4.com/mailman/listinfo/cgit>