summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--README42
1 files changed, 34 insertions, 8 deletions
diff --git a/README b/README
index a14418e..6d661d8 100644
--- a/README
+++ b/README
@@ -8,19 +8,35 @@ builtin cache to decrease server io-pressure.
8 8
9Installation 9Installation
10 10
11 $ make gitsrc=<path> 11 $ make
12 $ su 12 $ su
13 $ make prefix=<path> install 13 $ make install
14 14
15This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".
15 16
16Default value for gitsrc is "../git", and this directory should contain the 17Note: The initial "make" will create a submodule 'git' and clone the git
17git sources. 18repository at git://git.kernel.org/pub/scm/git/git.git in it. If you
19already have a local git git repository that you want to use as origin
20for the submodule, run
18 21
19Default value for prefix is "/var/www/htdocs/cgit". This directory will 22 $ git clone -s <path-to-git-repo> git
20contain "cgit.cgi" and "cgit.css" after 'make install'. 23 $ ./submodules.sh -u
21 24
22After installation, httpd.conf probably must be updated with a Directory- 25before running "make".
23section for cgit, possibly something like this: 26
27
28Dependencies
29
30 -git (1.5.2-rc0 or newer, due to git submodule) installed
31 -zip lib
32 -crypto lib
33 -openssl lib
34
35
36Apache configuration
37
38A new Directory-section must probably be added for cgit, possibly something
39like this:
24 40
25 <Directory "/var/www/htdocs/cgit/"> 41 <Directory "/var/www/htdocs/cgit/">
26 AllowOverride None 42 AllowOverride None
@@ -53,3 +69,13 @@ throughput over page freshness.
53 69
54The generated content contains the complete response to the client, including 70The generated content contains the complete response to the client, including
55the http-headers "Modified" and "Expires". 71the http-headers "Modified" and "Expires".
72
73
74The mis(sing) features
75
76Submodule links in the directory listing page have a fixed format per
77repository. This should probably be extended to a generic map between
78submodule path and url.
79
80
81The end.