summaryrefslogtreecommitdiffabout
authorLars Hjemli <hjemli@gmail.com>2007-05-11 10:13:15 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2007-05-11 10:13:15 (UTC)
commit5a217ed3e04a6ef7b066ded446582c0dd0fc5d3e (patch) (side-by-side diff)
tree9b5381ff0902c84006306faeb5a4f507ad4a18d5
parentded9393b173853d2e960f9b176aeb0bc4ed35be2 (diff)
downloadcgit-5a217ed3e04a6ef7b066ded446582c0dd0fc5d3e.zip
cgit-5a217ed3e04a6ef7b066ded446582c0dd0fc5d3e.tar.gz
cgit-5a217ed3e04a6ef7b066ded446582c0dd0fc5d3e.tar.bz2
Update README with submodule build info
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--README52
1 files changed, 39 insertions, 13 deletions
diff --git a/README b/README
index a14418e..6d661d8 100644
--- a/README
+++ b/README
@@ -10,15 +10,31 @@ Installation
- $ make gitsrc=<path>
+ $ make
$ su
- $ make prefix=<path> install
+ $ make install
+This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".
-Default value for gitsrc is "../git", and this directory should contain the
-git sources.
+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
-Default value for prefix is "/var/www/htdocs/cgit". This directory will
-contain "cgit.cgi" and "cgit.css" after 'make install'.
+ $ git clone -s <path-to-git-repo> git
+ $ ./submodules.sh -u
-After installation, httpd.conf probably must be updated with a Directory-
-section for cgit, possibly something like this:
+before running "make".
+
+
+Dependencies
+
+ -git (1.5.2-rc0 or newer, due to git submodule) installed
+ -zip lib
+ -crypto lib
+ -openssl lib
+
+
+Apache configuration
+
+A new Directory-section must probably be added for cgit, possibly something
+like this:
@@ -35,3 +51,3 @@ 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
+to runtime parameters, this file also contains a list of the repositories
displayed by cgit.
@@ -39,3 +55,3 @@ displayed by cgit.
A template cgitrc is shipped with the sources, and all parameters and default
-values are documented in this file.
+values are documented in this file.
@@ -44,4 +60,4 @@ 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),
+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
@@ -49,3 +65,3 @@ file is returned.
-If the cachefile has expired but cgit is unable to obtain a lock for it, the
+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
@@ -55 +71,11 @@ 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.
+
+
+The end.