CGIT 0.9

[ps-cgit] / README

diff --git a/README b/README
index a14418e8db8af0e239b524a0f37505e94f9993ba..1692ad6605f6ecd31dea3186966721c1215e0052 100644 (file)
--- a/README
+++ b/README
@@ -8,23 +8,48 @@ builtin cache to decrease server io-pressure.
 
 Installation
 
 
 Installation
 

-  $ make gitsrc=<path>
-  $ su
-  $ make prefix=<path> 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:

 
 

-Default value for gitsrc is "../git", and this directory should contain the
-git sources.
+  $ 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

 
 

-Default value for prefix is "/var/www/htdocs/cgit". This directory will 
-contain "cgit.cgi" and "cgit.css" after 'make install'.
+b) If you're building from a cgit tarball, you can download a proper git
+version like this:

 
 

-After installation, httpd.conf probably must be updated with a Directory-
-section for cgit, possibly something like this:
+  $ make get-git
+
+
+When either a) or b) has been performed, you can build and install cgit like
+this:
+
+  $ 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.7.4
+  -zip lib
+  -crypto lib
+  -openssl lib
+
+
+Apache configuration
+
+A new Directory-section must probably be added for cgit, possibly something
+like this:

 
   <Directory "/var/www/htdocs/cgit/">
       AllowOverride None
 
   <Directory "/var/www/htdocs/cgit/">
       AllowOverride None

-      Options ExecCGI
+      Options +ExecCGI

       Order allow,deny
       Allow from all
   </Directory>
       Order allow,deny
       Allow from all
   </Directory>


@@ -33,23 +58,38 @@ section for cgit, possibly something like this:
 Runtime configuration
 
 The file /etc/cgitrc is read by cgit before handling a request. In addition
 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.
 
 A template cgitrc is shipped with the sources, and all parameters and default
 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.

 
 
 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), 
+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
 file is returned.
 
 the content for the request is written into the proper cachefile before the
 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
 throughput over page freshness.
 
 The generated content contains the complete response to the client, including
 the http-headers "Modified" and "Expires".
 stale cachefile 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 missing 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 log-page should have more/better search options (author, committer,
+  pickaxe, paths) and possibly support arbitrary revision specifiers.
+
+* A set of test-scripts is required before cgit-1.0 can be released.
+
+Patches/bugreports/suggestions/comments are always welcome, please feel free
+to contact the author: hjemli@gmail.com