summaryrefslogtreecommitdiff
path: root/themes/spectral/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'themes/spectral/README.md')
-rw-r--r--themes/spectral/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/themes/spectral/README.md b/themes/spectral/README.md
new file mode 100644
index 0000000..4156582
--- /dev/null
+++ b/themes/spectral/README.md
@@ -0,0 +1,31 @@
+# Spectral
+
+Based on html5up’s [Spectral](https://html5up.net/spectral) theme.
+
+Specially made for my customer
+[kegelschiene.net](https://kegelschiene.net/en/), so some functions are
+missing. If you need one, that is not implemented yet, please open an issue!
+
+## Installation
+
+If this is your first hugo page, please read the [Basic Usage of
+Hugo](https://gohugo.io/getting-started/usage/) article.
+
+Clone this repo or download the zip, place it inside of the `themes` directory
+of your hugo site and use the `config.toml` file located in exampleSite as a
+starting point.
+
+## Examples
+
+If you want to have a look at a real life installation, feel free to explore
+the [repo of
+kegelschiene.net](https://git.sbruder.de/kegelschiene/site). It also includes
+the configuration for a multilingual site.
+
+For a minimial setup, check out the [exampleSite](exampleSite) directory. Its latest live build can be seen at <https://sbruder.github.io/spectral/>.
+
+## License
+
+This theme is licensed under the terms of the Creative Commons Attribution 3.0
+Unported (like html5up’s original theme). See the LICENSE.md file for more
+information on this.