From 5de206527ea10f8f04f4a337f03419590905a19e Mon Sep 17 00:00:00 2001 From: Christian Trott Date: Sun, 12 Nov 2023 20:13:42 -0700 Subject: [PATCH] Update README with local build instructions --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 72a241b..5dcb28d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # hpsf.io HPSF website + +## Requirements + +- [Install Hugo](https://gohugo.io/installation/) version v0.111.3 +- Need to be connected to internet to load [Hinode theme](https://github.com/gethinode/hinode) dependencies and modules +- Clone [this repository](https://github.com/hpsfoundation/hpsf.io) + +
+ +## How to run locally +1. Install all requirements +2. Change directory: `` +3. Install dependencies +``` +npm install +``` +4. Start development server +```bash +npm run start +# or +hugo server -D +``` +5. Open Chrome, web server is available at `http://localhost:` + - example: `http://localhost:1313`