Merge pull request #63 from ipfs/fix-package-scripts-and-instructions

Fix package scripts for macOS and improve setup instructions

Author: Mr0grog

.gitignore

@@ -1,3 +1,4 @@
+node_modules/
 public/
 tmp/
 themes/material/original/

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!
 

scripts/pkg2md.sh

@@ -24,13 +24,13 @@ baseurl="$4"
 
 echo "--- building docs for $name ($basedir/$name)"
 
-if echo "$name" | grep -P '^go-' > /dev/null; then
+if echo "$name" | grep '^go-' > /dev/null; then
 
   # Go: get the source, run godoc2md
   #
   # TODO also render subdirectories
   export GOPATH="$(pwd)/tmp/gopath"
-  go get "$repo" |& grep -v 'unrecognized import path' || true
+  go get "$repo" 2>&1 | grep -v 'unrecognized import path' || true
   (cd "$GOPATH/src/$repo" && git clean -fdxq && git fetch -q && git reset -q --hard "$ref")
   mkdir -p "$basedir/$name"
   cat <<EOF > "$basedir/$name/index.md"
@@ -42,7 +42,7 @@ url = "$baseurl/$name"
 
 EOF
   godoc2md -v -template scripts/go-pkg.md "$repo" >> "$basedir/$name/index.md"
-elif echo "$name" | grep -P '^js-' >/dev/null; then
+elif echo "$name" | grep '^js-' >/dev/null; then
 
   # JS: clone repo, npm install, run aegir docs
   tmpdir="tmp/js"