X-Git-Url: https://git.cameronkatri.com/cgit.git/blobdiff_plain/7618cac1ee3bf83424d9237c3c362a43c5b246e9..c712d5ac434b9ee8cb4e63a173a2538e1878637f:/README
diff --git a/README b/README
index 050e21e..7a6b4a4 100644
--- a/README
+++ b/README
@@ -1,102 +1,99 @@
+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).
+If you'd like to compile without Lua support, you may use:
+
+ $ make NO_LUA=1
+
+And if you'd like to specify a Lua implementation, you may use:
+
+ $ make LUA_PKGCONFIG=lua5.1
+
+If this is not specified, the Lua implementation will be auto-detected,
+preferring LuaJIT if many are present. Acceptable values are generally "lua",
+"luajit", "lua5.1", and "lua5.2".
-Dependencies:
- -git 1.5.3
- -zip lib
- -crypto lib
- -openssl lib
+Dependencies
+------------
+
+* libzip
+* libcrypto (OpenSSL)
+* libssl (OpenSSL)
+* optional: luajit or lua, most reliably used when pkg-config is available
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:
-
- AllowOverride None
- Options +ExecCGI
- Order allow,deny
- Allow from all
-
+
+ AllowOverride None
+ Options +ExecCGI
+ Order allow,deny
+ Allow from all
+
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
-displayed by cgit.
-
-A template cgitrc is shipped with the sources, and all parameters and default
-values are documented in this file.
-
+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).
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 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.
-
-* Branch- and tag-lists in the summary page can get very long, they should
- probably only show something like the ten "latest modified" branches and
- a similar number of "most recent" tags.
-
-* There should be a new page for browsing refs/heads and refs/tags, with links
- from the summary page whenever the branch/tag lists overflow.
+the HTTP headers `Modified` and `Expires`.
-* The log-page should have more/better search options (author, committer,
- pickaxe, paths) and possibly support arbitrary revision specifiers.
+Online presence
+---------------
-* A set of test-scripts is required before cgit-1.0 can be released.
+* The cgit homepage is hosted by cgit at
-Patches/bugreports/suggestions/comments are always welcome, please feel free
-to contact the author: hjemli@gmail.com
+* Patches, bug reports, discussions and support should go to the cgit
+ mailing list: . To sign up, visit
+