diff options
| author | Andy Yang <yzwdroid@gmail.com> | 2020-10-12 02:46:03 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-12 02:46:03 +0300 |
| commit | 20679c56b5cefc82ca87a238a825877630802706 (patch) | |
| tree | e85a49ece767c3dab84513669bb1cac4bdfa7f28 | |
| parent | 6478a68b1968d142e2f8c93069145f32baa13b89 (diff) | |
Update README.md to support submodule method (#11)
| -rw-r--r-- | README.md | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -15,10 +15,10 @@ Etch is a simple, responsive theme for [Hugo](https://gohugo.io) with a focus on ## Installation -To install `etch`, clone the repository into the `themes` folder in the root of your site. +To install `etch`, download the repository into the `themes` folder in the root of your site. ``` -$ git clone git@github.com:LukasJoswiak/etch.git themes/etch +$ git submodule add https://github.com/LukasJoswiak/etch.git themes/etch ``` Then, use the theme to generate your site. @@ -27,6 +27,6 @@ Then, use the theme to generate your site. $ hugo server -t etch ``` -Read the [wiki](https://github.com/LukasJoswiak/etch/wiki) to learn about more options. +Use the [sample configuration](https://github.com/LukasJoswiak/etch/wiki/Configuration#sample-configuration) as a starting point. See the [configuration](https://github.com/LukasJoswiak/etch/wiki/Configuration) page for more info. -***Note**: if you are using Netlify to host your site, you must [add Etch as a submodule](https://gohugo.io/hosting-and-deployment/hosting-on-netlify/#use-hugo-themes-with-netlify) instead of cloning.* +Read the [wiki](https://github.com/LukasJoswiak/etch/wiki) to learn about more options. |