about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorLukas Fleischer2014-01-08 19:45:29 +0100
committerJason A. Donenfeld2014-01-08 22:22:12 +0100
commite2416259efe8b9bdad9be9597b1a79443dafdb4e (patch)
tree1289eeaf1d757fc754cb204577e9b9f3d4a68dc8 /README
parentFix UTF-8 with syntax-highlighting.py (diff)
downloadcgit-e2416259efe8b9bdad9be9597b1a79443dafdb4e.tar.gz
cgit-e2416259efe8b9bdad9be9597b1a79443dafdb4e.zip
README: Spelling and formatting fixes
* Several small spelling and capitalization fixes.

* Use consistent and better-looking formatting that is compatible with
  AsciiDoc (and partly compatible with RST).

Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de>
Diffstat (limited to 'README')
-rw-r--r--README82
1 files changed, 41 insertions, 41 deletions
diff --git a/README b/README index 8e4ed53..0c35f96 100644 --- a/README +++ b/README
@@ -1,86 +1,86 @@
1cgit - CGI for Git
2==================
1 3
2 cgit - cgi for git 4This is an attempt to create a fast web interface for the Git SCM, using a
3 5built-in cache to decrease server I/O pressure.
4
5This is an attempt to create a fast web interface for the git scm, using a
6builtin cache to decrease server io-pressure.
7
8 6
9Installation 7Installation
8------------
10 9
11Building cgit involves building a proper version of git. How to do this 10Building cgit involves building a proper version of Git. How to do this
12depends on how you obtained the cgit sources: 11depends on how you obtained the cgit sources:
13 12
14a) If you're working in a cloned cgit repository, you first need to 13a) If you're working in a cloned cgit repository, you first need to
15initialize and update the git submodule: 14initialize and update the Git submodule:
16 15
17 $ git submodule init # register the git submodule in .git/config 16 $ git submodule init # register the Git submodule in .git/config
18 $ $EDITOR .git/config # if you want to specify a different url for git 17 $ $EDITOR .git/config # if you want to specify a different url for git
19 $ git submodule update # clone/fetch and checkout correct git version 18 $ git submodule update # clone/fetch and checkout correct git version
20 19
21b) If you're building from a cgit tarball, you can download a proper git 20b) If you're building from a cgit tarball, you can download a proper git
22version like this: 21version like this:
23 22
24 $ make get-git 23 $ make get-git
25
26 24
27When either a) or b) has been performed, you can build and install cgit like 25When either a) or b) has been performed, you can build and install cgit like
28this: 26this:
29 27
30 $ make 28 $ make
31 $ sudo make install 29 $ sudo make install
32 30
33This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit". You can 31This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
34configure this location (and a few other things) by providing a "cgit.conf" 32can configure this location (and a few other things) by providing a `cgit.conf`
35file (see the Makefile for details). 33file (see the Makefile for details).
36 34
35Dependencies
36------------
37 37
38Dependencies: 38* git 1.7.4
39 -git 1.7.4 39* zip lib
40 -zip lib 40* crypto lib
41 -crypto lib 41* openssl lib
42 -openssl lib
43
44 42
45Apache configuration 43Apache configuration
44--------------------
46 45
47A new Directory-section must probably be added for cgit, possibly something 46A new `Directory` section must probably be added for cgit, possibly something
48like this: 47like this:
49 48
50 <Directory "/var/www/htdocs/cgit/"> 49 <Directory "/var/www/htdocs/cgit/">
51 AllowOverride None 50 AllowOverride None
52 Options +ExecCGI 51 Options +ExecCGI
53 Order allow,deny 52 Order allow,deny
54 Allow from all 53 Allow from all
55 </Directory> 54 </Directory>
56 55
57 56
58Runtime configuration 57Runtime configuration
58---------------------
59 59
60The file /etc/cgitrc is read by cgit before handling a request. In addition 60The file `/etc/cgitrc` is read by cgit before handling a request. In addition
61to runtime parameters, this file may also contain a list of repositories 61to runtime parameters, this file may also contain a list of repositories
62displayed by cgit (see cgitrc.5.txt for further details). 62displayed by cgit (see `cgitrc.5.txt` for further details).
63
64 63
65The cache 64The cache
65---------
66 66
67When cgit is invoked it looks for a cachefile matching the request and 67When cgit is invoked it looks for a cache file matching the request and
68returns it to the client. If no such cachefile exist (or if it has expired), 68returns it to the client. If no such cache file exists (or if it has expired),
69the content for the request is written into the proper cachefile before the 69the content for the request is written into the proper cache file before the
70file is returned. 70file is returned.
71 71
72If the cachefile has expired but cgit is unable to obtain a lock for it, the 72If the cache file has expired but cgit is unable to obtain a lock for it, the
73stale cachefile is returned to the client. This is done to favour page 73stale cache file is returned to the client. This is done to favour page
74throughput over page freshness. 74throughput over page freshness.
75 75
76The generated content contains the complete response to the client, including 76The generated content contains the complete response to the client, including
77the http-headers "Modified" and "Expires". 77the HTTP headers `Modified` and `Expires`.
78
79 78
80Online presence 79Online presence
80---------------
81 81
82* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/> 82* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
83 83
84* Patches, bugreports, discussions and support should go to the cgit 84* Patches, bug reports, discussions and support should go to the cgit
85 mailing list: <cgit@lists.zx2c4.com>. To sign up, visit 85 mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
86 <http://lists.zx2c4.com/mailman/listinfo/cgit> 86 <http://lists.zx2c4.com/mailman/listinfo/cgit>