Add README
parent
f8d40c4e41
commit
af46d85417
|
|
@ -0,0 +1,20 @@
|
||||||
|
## 🚀 Getting Started
|
||||||
|
|
||||||
|
### ⚙️ Prerequisites
|
||||||
|
|
||||||
|
To run the website locally, follow these steps:
|
||||||
|
|
||||||
|
- Install [Hugo Extended v0.140+](https://github.com/gohugoio/hugo/releases/tag/v0.140.0) on your $PATH
|
||||||
|
- Navigate to project root folder
|
||||||
|
- Run `hugo server`
|
||||||
|
- Visit `localhost:1313` on your browser
|
||||||
|
|
||||||
|
That's it! Any changes you make will be hot reloaded.
|
||||||
|
|
||||||
|
## WARNING:
|
||||||
|
|
||||||
|
For maximum compatibility we recommend sticking with Hugo `v0.140.0` (**Extended** edition, linked above.) We haven't tested other versions.
|
||||||
|
|
||||||
|
## 💻 Automatic Deployment
|
||||||
|
|
||||||
|
Anything we `git push` will be published to [guide.handmadecities.com](https://guide.handmadecities.com) automatically. PROCEED WITH CAUTION!
|
||||||
Loading…
Reference in New Issue