diff options
author | Sean Lane <5761232+seanlane@users.noreply.github.com> | 2019-03-04 22:21:30 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-03-04 22:21:30 +0300 |
commit | 06eb554a5da83cadecf90355834476d83b02d822 (patch) | |
tree | 333aba96d56764ecdaa7b956c6b17e38075923ec | |
parent | 3bdeb9968435eafb4897072a2ce1a88a3b8d6eb2 (diff) |
Update README.md
Mention the need for the extended version of Hugo per comments from @joede on #1
-rw-r--r-- | README.md | 2 |
1 files changed, 2 insertions, 0 deletions
@@ -8,6 +8,8 @@ A theme for [Hugo](https://gohugo.io/) based on the [Chowdown](https://github.co ## Quick Start +0. Install Hugo with your favorite package manager, or follow their [Installation Guide](https://gohugo.io/getting-started/installing/) + - Note that the _extended_ version of Hugo is required since this theme needs SCSS support. At the time of writing, this is the version found by installing via [HomeBrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/hugo.rb) and the [Arch User Repository](https://www.archlinux.org/packages/community/x86_64/hugo/). If that isn't the case for your package manager, then install using `$ go install --tags extended` as documented in the Hugo Install Docs. 1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/seanlane/gochowdown.git themes/gochowdown`. 2. Configure your `config.toml` or `config.yaml`. 3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`. |