Diff options
Diffstat (limited to '')
| -rw-r--r-- | README.txt | 22 |
1 file changed, 10 insertions, 12 deletions
@@ -11,11 +11,9 @@ Installation Building cgit involves building a proper version of Git. How to do this depends on how you obtained the cgit sources. -In a cloned cgit repository, first initialize and update the Git submodule. +In a cloned cgit repository, first fetch 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 update --init From a cgit tarball, download a proper git version instead. @@ -71,7 +69,7 @@ repositories to display. A fully commented starting point with every option at its default is in custom/cgitrc, and MANUAL.txt documents each option in full. -Customization +Customisation ------------- Every page is one document with the same skeleton, so a site stylesheet or @@ -93,7 +91,7 @@ script added through the css and js options has stable hooks to work with. ext- followed by the file extension. * The commit and tag pages use table.commit-info, the trailer table is table.commit-trailers, the diffstat is table.diffstat and each file of a diff - is div.file, or tbody.file in the side by side view, with the path in + is div.file, or tbody.file in the side-by-side view, with the path in data-path. The blob and blame pages open with div.blob-header. * Relative ages are time elements with an age-* class and the timestamp in data-ut, while a date shown in full is a plain time element. Line numbers are @@ -135,7 +133,7 @@ and each script's header lists the exact install commands for its own. luaposix. * The email filters, email-gravatar.lua and email-libravatar.lua, need luaossl. * The syntax highlighter, syntax-highlight.lua, needs lpeg and a Scintillua - lexer set. + recent enough to have detect(). * The about-page renderer, about-render.lua, needs lpeg for markdown and man pages. Plain text needs only Lua. * link-commits.lua and link-trailers.lua need nothing beyond Lua itself. @@ -144,13 +142,13 @@ On Lua 5.5 the auth and email filters need luaossl 20260910 or later, since earlier builds fail to load there. -URLs and query parameters +Urls and query parameters ------------------------- cgit serves every page from one CGI program, so a url names the repository, the page and a path inside that page. There are two forms and they carry the same -information. With virtual-root set, a request is a path, written as -/<repo>/<page>/<path> with anything else as a query string. Without it, the +information. The one cgit's own links take is a path, written as +/<repo>/<page>/<path> with anything else as a query string. In the other the whole request lives in the query string as ?url=<repo>/<page>/<path>. The page name is the second element and is one of about, atom, blame, blob, @@ -187,8 +185,8 @@ one, where a value of all marks the few not tied to particular pages. | s | index | sort key for the listing | | showmsg | log | show full commit messages | | period | stats | the statistics window, one of w, m, q or y | -| dt | diff commit | 0 unified, 1 side by side or 2 stat only | -| ss | diff commit | shorthand for the side by side diff | +| dt | diff commit | 0 unified, 1 side-by-side or 2 stat only | +| ss | diff commit | shorthand for the side-by-side diff | | all | atom | include every ref rather than one branch | | context | diff commit | lines of context around a diff hunk | | ignorews | diff commit | ignore whitespace when diffing | |