diff options
author | Emiel Hollander <EmielH@users.noreply.github.com> | 2018-08-06 22:22:35 +0300 |
---|---|---|
committer | Emiel Hollander <EmielH@users.noreply.github.com> | 2018-08-06 22:22:35 +0300 |
commit | c254011c0fa7752b5dc0f29070f879a1032a8dd7 (patch) | |
tree | 0889334d434fa1b380c8105f485403f3947b253a /README.md | |
parent | 1b628d32219f2e46e153bfad919e2a250a4e95c4 (diff) |
Update README.MD with additional installation instructions
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 30 |
1 files changed, 29 insertions, 1 deletions
@@ -6,14 +6,42 @@ This is a port of the [Tale theme for Jekyll](https://github.com/chesterhow/tale ## 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. +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. ``` git submodule add https://github.com/EmielH/tale-hugo.git themes/tale ``` +Alternatively, you can clone the theme into your project. + +``` +git clone https://github.com/EmielH/tale-hugo.git themes/tale +``` + +Add the following line to `config.toml` to tell Hugo to use the theme. + +``` +theme = "tale" +``` + +Alternatively, you can tell Hugo to use the theme with the `server` command. + +``` +hugo server -t tale +``` + For more information, read the official [setup guide]( https://gohugo.io/overview/installing/) of Hugo. +### Updating + +If you have installed the theme as a git submodule, you can update the theme by issuing the following command inside your project folder. + +``` +git submodule update --remote --rebase +``` + +If you have cloned the theme, you can run `git pull` inside the theme folder. + ## Acknowledgments Thanks |