From 1b628d32219f2e46e153bfad919e2a250a4e95c4 Mon Sep 17 00:00:00 2001 From: Emiel Hollander Date: Mon, 6 Aug 2018 21:03:28 +0200 Subject: Update README.MD with installation instructions and acknowledgments --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 17ee77a..70795c5 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,22 @@ This is a port of the [Tale theme for Jekyll](https://github.com/chesterhow/tale ![Tale screenshot](https://raw.githubusercontent.com/EmielH/tale-hugo/master/images/screenshot.png) +## Installation + +The easiest way to install this theme is to add it as a submodule. Inside the folder of your Hugo site, run the following command. + +``` +git submodule add https://github.com/EmielH/tale-hugo.git themes/tale +``` + +For more information, read the official [setup guide]( https://gohugo.io/overview/installing/) of Hugo. + +## Acknowledgments + +Thanks + +- to [Chester How](//github.com/chesterhow) for creating the original [Tale theme for Jekyll](https://chesterhow.github.io/tale/), +- to [onedrawingperday](//github.com/digitalcraftsman), [bep](//github.com/bep) and [digitalcraftsman](//github.com/digitalcraftsman) for their help in getting the theme working correctly with Hugo. + ## License -See [LICENSE](https://github.com/EmielH/tale-hugo/blob/master/LICENSE) \ No newline at end of file +See [LICENSE](https://github.com/EmielH/tale-hugo/blob/master/LICENSE). \ No newline at end of file -- cgit v1.2.3