diff options
| author | Robert Kaussow <mail@geeklabor.de> | 2020-09-12 12:57:41 +0300 |
|---|---|---|
| committer | Robert Kaussow <mail@geeklabor.de> | 2020-09-12 12:57:41 +0300 |
| commit | f4a3018d478b6d1a33d0814afccacadd8137a7db (patch) | |
| tree | a6054ad81a061bff7eefb7ee2df6536ad3cc4d25 /README.md | |
| parent | 862d2742fbbe591f402ad9d89149e4cdcdf82b2e (diff) | |
[skip ci] improve getting started documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -4,12 +4,28 @@ [](https://gohugo.io) [](https://github.com/xoxys/hugo-geekdoc/releases/latest) [](https://github.com/xoxys/hugo-geekdoc/graphs/contributors) -[](LICENSE) +[](https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE) Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of got alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).  +## Build and release process + +This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by [gulp](https://gulpjs.com/) and bundled in a release tarball. You can download the latest release from the [GitHub release page](https://github.com/xoxys/hugo-geekdoc/releases). + +Due to the fact that `gulp` is used as pre-processor the theme cannot be used from the master branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `gulp` locally and run the default pipeline once to create all required assets. + +```Shell +# install required packages from package.json +npm install + +# run gulp pipeline to build required assets +gulp default +``` + +See the [Getting Started Guide](https://geekdocs.de/usage/getting_started/) for details about the different setup options. + ## Contributors Special thanks goes to all [contributors](https://github.com/xoxys/hugo-geekdoc/graphs/contributors). |