diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c6a56e4 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Black & Light +============= +A High contrast, text oriented, performant and Javascript-free theme for Hugo. + +## Features +* Loads in a single request (with web-fonts disabled). +* 100 / 100 on Google Page Speed test (100 / 100 on mobile with web-fonts disabled). +* Scriptless (unless you configure Google Analytics). +* Styles inlined in head. +* High Contrast. + + + +## Installation +Inside the folder of your Hugo site run: +``` + git submodule git@github.com:davidhampgonsalves/hugo-black-and-light-theme.git themes/black-and-light +``` +For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo. + +## The config file +Copy the [`config.toml`](//github.com/davidhampgonsalves/hugo-black-and-light-theme/blob/master/exampleSite/config.toml) from this themes exampleSite to your Hugo site or use it as a reference. + +## License +This theme is released under the GNU 3.0 license. For more information read the [license](https://github.com/davidhampgonsalves/hugo-black-and-light-theme/blob/dev/LICENSE.md). |