peruna/README.md

25 lines
735 B
Markdown
Raw Normal View History

2018-09-03 07:57:03 +00:00
# Peruna
2018-04-03 09:51:11 +00:00
2018-09-03 07:57:03 +00:00
Peruna is a fork of the Potato Dark theme for Hugo.
2018-04-03 09:51:11 +00:00
2018-09-03 07:57:03 +00:00
And yes, I really went and named it Peruna. Deal with it.
2018-04-03 09:51:11 +00:00
## Configuration
You may specify following options in `config.toml` of your site to make use of
this theme's features.
2018-09-03 07:57:03 +00:00
For getting started with potato dark, copy the [config.toml](https://git.quad.moe/quad/peruna/blob/master/exampleSite/config.toml) file from the exampleSite directory inside Potato's repository to your site repository.
2018-04-03 09:51:11 +00:00
```shell
2018-04-03 10:09:21 +00:00
$ cp themes/potato-dark/exampleSite/config.toml .
2018-04-03 09:51:11 +00:00
```
Now, you can start editing this file and add your own information!
## License
2018-09-03 07:57:03 +00:00
Original had the MIT license, so I guess I'm keeping that.
It basically reads like a more serious version of the WTFPL anyhow.