Commit 25334538117daefd9563ea41e54aa042f63c85b1 Parent: 507b1d812396dd5a14c7e6bf2dc4038a5626c9a5 Author: mcol <mcol@posteo.net> Date: 2021-11-30 20:16:22 +0000 Committer: mcol <mcol@posteo.net> Committed: 2021-11-30 20:16:22 +0000 Add `gitserve -t` to readme and docs
README.rst Modified
@@ -31,6 +31,10 @@ Documentation and a preview of the kind of pages ``gitserve`` can generate is available here_. +If you like skipping the manual, running ``gitserve --template`` will create a +base template and config in the current folder from which you can create your +own. + Contributing ------------
DOCUMENTATION.md Modified
@@ -11,7 +11,8 @@ gitserve is configured using a [dhall](https://dhall-lang.org) config file. The [example config](https://github.com/m-col/gitserve/blob/master/config.dhall) is -a good place to start. +a good place to start, or alternatively create one in the current folder by +running `gitserve -t`. It requires the following settings: @@ -28,13 +29,15 @@ See the CLI help message for usage: - Usage: gitserve [-c|--config CONFIG] [-q|--quiet] [-f|--force] [-v|--version] + Usage: gitserve [-c|--config CONFIG] [-q|--quiet] [-f|--force] [-t|--template] + [-v|--version] 🐙 Templated web page generator for your git repositories Available options: -c,--config CONFIG Configuration file to use (Default: ./config.dhall). -q,--quiet Suppress non-error output. -f,--force Force regeneration of all files. + -t,--template Create a template and config in the current folder. -v,--version Print the gitserve's version. -h,--help Show this help text @@ -45,6 +48,9 @@ Templates --------- +A base template can be created in the current folder by running `gitserve -t`. +This can be used as a starting point to creating your own template. + ### Folder structure The files that gitserve outputs are generated using