diff --git a/README.md b/README.md index e69e3d4..f5f449c 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,46 @@ This is a Hugo theme that gets used within all of our websites like our blog, documentation and also the redirects. If you commit any changes to the `master` branch it will trigger rebuilds of all the related websites. +## Install + +You need an existing [Hugo](https://github.com/spf13/hugo) website, than you can +just download our prebuilt [theme](https://dl.gitea.io/theme/master.tar.gz), put +it into your `themes/gitea` folder and enable the theme with the +`theme = "gitea"` option of your website. + +## Development + +We choose [npm](https://www.npmjs.com/) to fetch our dependencies and +[gulp](http://gulpjs.com/) for the pipeline. We won't cover the installation of +nodejs or npm, for that you can find enough guides depending on your operating +system. First of all you have to install the required dependencies: + +``` +npm install -q +``` + +After you have successfully installed the required dependencies you should be +able to use these commands to just clean and build generated sources of the +theme: + +``` +npm run clean +npm run build +npm run release +``` + +If you want to do more development on the theme we suggest to use the `watch` +task we have defined to get the changes directly built after saving changes to +a file: + +``` +npm run watch +``` + +When you are done with your changes just create a pull request, after merging +the pull request the theme will be published to our [download page] +(https://dl.gitea.io/theme) automatically. + ## Contributing Fork -> Patch -> Push -> Pull Request