diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d8b17b --- /dev/null +++ b/README.md @@ -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!