diff --git a/.gitignore b/.gitignore index 1add03f..f1e3f9d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +node_modules/ public/ tmp/ themes/material/original/ diff --git a/README.md b/README.md index 975b13b..2dfa107 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,27 @@ TODO ## Developing the site -* [Install Hugo](https://gohugo.io/) -* In the root directory, run `hugo server` +### One-Time Setup + +1. [Install Hugo](https://gohugo.io/) +2. Install [AEgir](https://www.npmjs.com/package/aegir) + + ```sh + npm install -g aegir + ``` + +3. Download IPFS libraries and tools (e.g. go-ipfs, js-ipfs) and generate their documentation: + + ```sh + make packages + ``` + + (Repeat this step anytime a package with autogenerated documentation has a new release.) + + +### Build and Run the Site + +* In the root directory, run `make serve` * Load http://localhost:1313 in your web browser * Edit and add things!