Update copyright headers to have latest dates.

[cgit.git] / README

diff --git a/README b/README
index 6d661d824cadab3117ffd9293143ea83a221a3ea..5a7bdf855ec556c917f75a141f3df5dd22b2a983 100644 (file)
--- a/README
+++ b/README
@@ -8,26 +8,35 @@ builtin cache to decrease server io-pressure.
 
 Installation
 
-  $ make
-  $ su
-  $ make install
+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:
 
-This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".
+  $ 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
 
-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
+b) If you're building from a cgit tarball, you can download a proper git
+version like this:
 
-  $ git clone -s <path-to-git-repo> git
-  $ ./submodules.sh -u
+  $ make get-git
 
-before running "make".
 
+When either a) or b) has been performed, you can build and install cgit like
+this:
+
+  $ make
+  $ sudo make install
 
-Dependencies
+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).
 
-  -git (1.5.2-rc0 or newer, due to git submodule) installed
+
+Dependencies:
+  -git 1.7.4
   -zip lib
   -crypto lib
   -openssl lib
@@ -40,7 +49,7 @@ like this:
 
   <Directory "/var/www/htdocs/cgit/">
       AllowOverride None
-      Options ExecCGI
+      Options +ExecCGI
       Order allow,deny
       Allow from all
   </Directory>
@@ -49,11 +58,8 @@ like this:
 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.
+to runtime parameters, this file may also contain a list of repositories
+displayed by cgit (see cgitrc.5.txt for further details).
 
 
 The cache
@@ -71,11 +77,9 @@ The generated content contains the complete response to the client, including
 the http-headers "Modified" and "Expires".
 
 
-The mis(sing) features
-
-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://hjemli.net/git/cgit/about
 
-The end.
+* Patches, bugreports, discussions and support should go to the cgit
+  mailing list: cgit@hjemli.net