summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b5c613
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Blank
+
+Blank — starter [Hugo](//gohugo.io/) theme for developers. Use it to make your own theme.
+
+![Blank theme screenshot](/images/splash.png)
+
+## Installation
+
+In your Hugo site `themes` directory, run:
+
+```
+$ git clone https://github.com/vimux/blank
+```
+
+Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `blank`.
+
+```
+theme = "blank"
+```
+
+For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
+
+## Contributing
+
+Have you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](//github.com/Vimux/blank/issues) to let me know. Or make directly a [pull request](//github.com/Vimux/blank/pulls).
+
+## License
+
+This theme is released under the [MIT license](LICENSE.md). \ No newline at end of file