From c128b75243bc13e01385ee210cd28cceff549f09 Mon Sep 17 00:00:00 2001 From: Samuel Guyah Date: Fri, 14 Dec 2018 00:00:05 -0500 Subject: [PATCH] Update README (#11) * Update README.md Following the proposed set-up on https://gohugo.io/getting-started/quick-start/ , I added the instructions for downloading the theme as a submodule. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index f1cc8aa..118663f 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,12 @@ Run this command from the root of your Hugo directory (Git needs to be installed $ git clone https://github.com/Track3/hermit.git themes/hermit ``` +Or, if your Hugo site is already in git, you can include this repository as a [git submodule](https://git-scm.com/book/de/v1/Git-Tools-Submodule). This makes it easier to update this theme. For this you need to run: + +```bash +$ git submodule add https://github.com/Track3/hermit.git themes/hermit +``` + Alternatively, if you are not familiar with git, you can download the theme as a `.zip` file, unzip the theme contents, and then move the unzipped source into your `themes` directory. For more information, read the official [documentation](https://gohugo.io/themes/installing-and-using-themes/) of Hugo.