]> gitweb.ps.run Git - ps-cgit/blobdiff - cgitrc.5.txt
Add support for "readme" option
[ps-cgit] / cgitrc.5.txt
index 5d779733ddc3674a80d387d3bcb0c18dc0f9ab3d..187031aaa408a486eb1673d96ad68c1f0bbfb5df 100644 (file)
@@ -234,6 +234,10 @@ project-list::
        should loaded as git repositories. This must be defined prior to
        scan-path. Default value: none. See also: scan-path.
 
+readme::
+       Text which will be used as default value for "repo.readme". Default
+       value: none.
+
 remove-suffix::
        If set to "1" and scan-path is enabled, if any repositories are found
        with a suffix of ".git", this suffix will be removed for the url and
@@ -371,7 +375,9 @@ repo.path::
 
 repo.readme::
        A path (relative to <repo.path>) which specifies a file to include
-       verbatim as the "About" page for this repo. Default value: none.
+       verbatim as the "About" page for this repo. You may also specify a
+       git refspec by head or by hash by prepending the refspec followed by
+       a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the