diff --git a/README.md b/README.md index 26ad5d6..a808655 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,11 @@ We use [Netlify](https://netlify.com) to host our website and generate previews. ## Local Development -1. Git clone this repository: `git clone https://github.com/PrivSec-dev/privsec.dev` -2. [Install Hugo](https://github.com/PrivSec-dev/privsec.dev) -3. Run `hugo serve`. The local version of the website should be available at `http://127.0.0.1:1313` -4. You can run `git submodule update --remote --merge` to update the PaperMod theme -5. You can run `./external-blogs.sh` to pull the latest versions of the articles from [wonderfall.dev](https://wonderfall.dev) and place them in `/content` +1. [Install Hugo](https://gohugo.io/getting-started/installing/) +1. Clone this repository: `git clone --recurse-submodules https://github.com/PrivSec-dev/privsec.dev` +1. Run `hugo serve` to start the local development server at (by default) `http://localhost:1313` + - Alternatively run `hugo` to simply build the site into the `/public` directory + +- Run `git submodule update --merge` to update the [WonderMod theme](https://github.com/Wonderfall/hugo-WonderMod) to the version specified in this repo + - Run `git submodule update --remote --merge` to update to the upstream master branch of WonderMod +- Run `./external-blogs.sh` to pull the latest versions of the articles from [wonderfall.dev](https://wonderfall.dev) and place them in `/content`