diff options
| author | Emiel Hollander <EmielH@users.noreply.github.com> | 2018-09-07 23:38:26 +0300 |
|---|---|---|
| committer | Emiel Hollander <EmielH@users.noreply.github.com> | 2018-09-07 23:38:26 +0300 |
| commit | 8560c5501c2563475c1c0490dbfc46c23511baac (patch) | |
| tree | 6de6ead7b9be3783e1058631aeafd3e70c252981 /README.md | |
| parent | e3cb03f59c9fde7365fdc35483ce9359f6ca6539 (diff) | |
Update README.MD, fix wrong link
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -6,6 +6,8 @@ This is a port of the [Tale theme for Jekyll](https://github.com/chesterhow/tale ## Installation +### 1. Install the theme + If your site is also under version control using git, the easiest way to install this theme is to add it as a submodule. If you have not created a git repo for your project yet, you need to run `git init` beforehand. Inside the folder of your Hugo site, run the following command. ``` @@ -18,6 +20,8 @@ Alternatively, you can clone the theme into your project. git clone https://github.com/EmielH/tale-hugo.git themes/tale ``` +### 2. Configure Hugo + Add the following line to `config.toml` to tell Hugo to use the theme. ``` @@ -30,9 +34,11 @@ Alternatively, you can tell Hugo to use the theme with the `server` command. hugo server -t tale ``` +### Additional information + For more information, read the official [setup guide]( https://gohugo.io/overview/installing/) of Hugo. -### Updating +### Update the theme If you have installed the theme as a git submodule, you can update the theme by issuing the following command inside your project folder. @@ -47,7 +53,7 @@ If you have cloned the theme, you can run `git pull` inside the theme folder. 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, +- to [onedrawingperday](//github.com/onedrawingperday), [bep](//github.com/bep) and [digitalcraftsman](//github.com/digitalcraftsman) for their help in getting the theme working correctly with Hugo, - to [lucperkins](https://github.com/lucperkins) for the [Fresh theme](https://github.com/lucperkins/hugo-fresh) from which I used some useful snippets of code. ## License |