Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Commit

Permalink
Update development instructions in README
Browse files Browse the repository at this point in the history
Include installation of AEgir, downloading/building package docs, and switch `hugo server` to `make serve` since, if we ever need it to do more, we probably want people calling Make instead of Hugo directly.

License: MIT
Signed-off-by: Rob Brackett <rob@robbrackett.com>
  • Loading branch information
Mr0grog committed Mar 31, 2018
1 parent fa9ddc9 commit af83cd0
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules/
public/
tmp/
themes/material/original/
Expand Down
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down

0 comments on commit af83cd0

Please sign in to comment.