tblyler/etch
1
0
Fork 0
mirror of https://github.com/LukasJoswiak/etch.git synced 2024-04-30 07:28:32 -04:00
Code Issues Projects Releases Wiki Activity

Update README.md to support submodule method (#11)

Browse source
This commit is contained in:
Andy Yang 2020-10-11 19:46:03 -04:00 committed by GitHub
parent 6478a68b19
commit 20679c56b5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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.