marius/risotto
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update installation instructions

Browse source
This commit is contained in:
Joe Roe 2024-02-12 09:56:56 +01:00
parent 188903ac09
commit d440b668cd
No known key found for this signature in database
GPG key ID: 032DAD09129ADB03
1 changed files with 8 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -19,17 +19,16 @@ risotto is a minimalist, responsive [hugo](https://gohugo.io) theme inspired by
## Install
The easiest way to install the theme is to clone this repository into your site's `themes` directory:
The easiest way to install the theme is to [download the latest release](https://github.com/joeroe/risotto/releases/tag/release) and extract it to your project's `themes/` directory.
You can also clone this repository into your site's `themes` directory and checkout the latest release:
```shell
git clone https://github.com/joeroe/risotto themes/risotto
git clone https://github.com/joeroe/risotto themes/risotto && cd themes/risotto
git checkout v0.3.0
```
If your site is already a git repository, you can add the theme as a submodule instead:
```shell
git submodule add https://github.com/joeroe/risotto.git themes/risotto
```
Note that this will not work if your site is itself a git repository.
In that case, you can add the theme as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), but this is not recommended due to the difficulty of tracking a specific release.
## Update
@ -40,15 +39,11 @@ cd themes/risotto
git pull
```
Or, if you added it as a git submodule:
```shell
git submodule update --remote
```
Otherwise, simply [download the latest release](https://github.com/joeroe/risotto/releases/tag/release) and extract it to your project's `themes/` directory, replacing the old version.
## Configure
To use the theme, add `theme = 'risotto'` to your site's `config.toml`, or `theme: risotto` to your `config.yaml` respectively.
To use the theme, add `theme = 'risotto'` to your site's `config.toml`, or `theme: risotto` to your `config.yaml`.
See `exampleSite/config.toml` for the theme-specific parameters you need to add to your site's `config.toml` or `config.yaml` to configure the theme.