about summary refs log tree commit diff
diff options
context:
space:
mode:
authorLukas Fleischer <cgit@cryptocrack.de>2014-01-08 19:45:29 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2014-01-08 22:22:12 +0100
commite2416259efe8b9bdad9be9597b1a79443dafdb4e (patch)
tree1289eeaf1d757fc754cb204577e9b9f3d4a68dc8
parentFix UTF-8 with syntax-highlighting.py (diff)
downloadcgit-pink-e2416259efe8b9bdad9be9597b1a79443dafdb4e.tar.gz
cgit-pink-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 '')
-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 @@
+cgit - CGI for Git
+==================
 
-                       cgit - cgi for git
-
-
-This is an attempt to create a fast web interface for the git scm, using a
-builtin cache to decrease server io-pressure.
-
+This is an attempt to create a fast web interface for the Git SCM, using a
+built-in cache to decrease server I/O pressure.
 
 Installation
+------------
 
-Building cgit involves building a proper version of git. How to do this
+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:
+initialize and update the Git submodule:
 
-  $ 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
+    $ 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
 
 b) If you're building from a cgit tarball, you can download a proper git
 version like this:
 
-  $ make get-git
-
+    $ make get-git
 
 When either a) or b) has been performed, you can build and install cgit like
 this:
 
-  $ make
-  $ sudo make install
+    $ 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"
+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
+------------
 
-Dependencies:
-  -git 1.7.4
-  -zip lib
-  -crypto lib
-  -openssl lib
-
+* git 1.7.4
+* zip lib
+* crypto lib
+* openssl lib
 
 Apache configuration
+--------------------
 
-A new Directory-section must probably be added for cgit, possibly something
+A new `Directory` section must probably be added for cgit, possibly something
 like this:
 
-  <Directory "/var/www/htdocs/cgit/">
-      AllowOverride None
-      Options +ExecCGI
-      Order allow,deny
-      Allow from all
-  </Directory>
+    <Directory "/var/www/htdocs/cgit/">
+        AllowOverride None
+        Options +ExecCGI
+        Order allow,deny
+        Allow from all
+    </Directory>
 
 
 Runtime configuration
+---------------------
 
-The file /etc/cgitrc is read by cgit before handling a request. In addition
+The file `/etc/cgitrc` is read by cgit before handling a request. In addition
 to runtime parameters, this file may also contain a list of repositories
-displayed by cgit (see cgitrc.5.txt for further details).
-
+displayed by cgit (see `cgitrc.5.txt` for further details).
 
 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),
-the content for the request is written into the proper cachefile before the
+When cgit is invoked it looks for a cache file matching the request and
+returns it to the client. If no such cache file exists (or if it has expired),
+the content for the request is written into the proper cache file before the
 file is returned.
 
-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
+If the cache file has expired but cgit is unable to obtain a lock for it, the
+stale cache file 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 HTTP headers `Modified` and `Expires`.
 
 Online presence
+---------------
 
 * The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
 
-* Patches, bugreports, discussions and support should go to the cgit
+* Patches, bug reports, discussions and support should go to the cgit
   mailing list: <cgit@lists.zx2c4.com>. To sign up, visit 
   <http://lists.zx2c4.com/mailman/listinfo/cgit>
&follow=1'>Add 'about-filter' and 'repo.about-filter' optionsLars Hjemli These options can be used to execute a filter command on each about-page, both top-level and for each repository (repo.about-filter can be used to override the current about-filter). Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-08-09ui-summary: enable arbitrary paths below repo.readmeLars Hjemli This change makes it possible to include any number of pages below the 'about' tab for a repository. The path is assumed to be located in the same directory as the 'repo.readme' file. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-08-09cgit.c: allow repo.*-filter options to unset the current defaultLars Hjemli If e.g. repo.commit-filter is specified as an empty string, this is now properly handled as disabling the global commit-filter setting for the current repository. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-08-09Add support for repo.commit-filter and repo.source-filterLars Hjemli These options can be used to override the default commit- and source- filter settings per repository. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-08-08Expose file extension in tree lists as class to allow nicer tree stylingMartin Szulecki Signed-off-by: Martin Szulecki <opensuse@sukimashita.com> 2009-08-08Introduce noplainemail option to hide email adresses from spambotsMartin Szulecki Signed-off-by: Martin Szulecki <opensuse@sukimashita.com> 2009-07-31ui-commit: add support for 'commit-filter' optionLars Hjemli This new option specifies a filter which is executed on the commit message, i.e. the commit message is written to the filters STDIN and the filters STDOUT is included verbatim as the commit message. This can be used to implement commit linking by creating a simple shell script in e.g. /usr/bin/cgit-commit-filter.sh like this: #/bin/sh sed -re 's|\b([0-9a-fA-F]{6,40})\b|<a href="./?id=\1">\1</a>|g' Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-31ui-tree: add support for source-filter optionLars Hjemli This new option is used to specify an external command which will be executed when displaying blob content in the tree view. Blob content will be written to STDIN of the filter and STDOUT from the filter will be included verbatim in the html output from cgit. The file name of the blob will be passed as the only argument to the filter command. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-31ui-snapshot: use cgit_{open|close}_filter() to execute compressorsLars Hjemli This simplifies the code in ui-snapshot.c and makes the test-suite verify the new filter-functions. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-31Add generic filter/plugin infrastructureLars Hjemli The functions cgit_open_filter() and cgit_close_filter() can be used to execute filters on the output stream from cgit. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25Add support for mime type registration and lookupLars Hjemli This patch makes it possible to register mappings from filename extension to mime type in cgitrc and use this mapping when returning blob content in `plain` view. The reason for adding this mapping to cgitrc (as opposed to parsing something like /etc/mime.types) is to allow quick lookup of a limited number of filename extensions (/etc/mime-types on my machine currently contains over 700 entries). NB: A nice addition to this patch would be to parse /etc/mime.types when `plain` view is requested for a file with an extension for which there is no mapping registered in cgitrc. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25cgit.h: keep config flags sortedLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25cgitrc.5.txt: document 'embedded' and 'noheader'Lars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25Add support for 'noheader' optionLars Hjemli This option can be used to disable the standard cgit page header, which might be useful in combination with the 'embedded' option. Suggested-by: Mark Constable <markc@renta.net> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25cgitrc.5.txt: document 'head-include'Lars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25ui-blob: return 'application/octet-stream' for binary blobsLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-07-25ui-plain: Return 'application/octet-stream' for binary files.Remko Tronçon Signed-off-by: Remko Tronçon <git@el-tramo.be> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-06-11use cgit_httpscheme() for atom feedDiego Ongaro 2009-06-11add cgit_httpscheme() -> http:// or https://Diego Ongaro 2009-06-07Return http statuscode 404 on unknown branchLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-06-07Add head-include configuration option.Mark Lodato This patch adds an option to the configuration file, "head-include", which works just like "header" or "footer", except the content is put into the HTML's <head> tag. 2009-03-15CGIT 0.8.2.1Lars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-03-15Fix doc-related glitches in Makefile and .gitignoreLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-03-15ui-snapshot: avoid segfault when no filename is specifiedLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-03-15fix segfault when displaying empty blobsEric Wong When size is zero, subtracting one from it turns it into ULONG_MAX which causes an out-of-bounds access on buf. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-19Add support for HEAD requestsLars Hjemli This is a quick 'n dirty hack which makes cgit honor HEAD requests. Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-19Add support for ETag in 'plain' viewLars Hjemli When downloading a blob identified by its path, the client might want to know if the blob has been modified since a previous download of the same path. To this end, an ETag containing the blob SHA1 seems to be ideal. Todo: add support for HEAD requests... Suggested-by: Owen Taylor <otaylor@redhat.com> Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-12ui-tree: escape ascii-text properly in hexdump viewLars Hjemli Signed-off-by: Lars Hjemli <hjemli@gmail.com> 2009-02-12Makefile: add doc-related targetsLars Hjemli