summaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authordigitalcraftsman <[email protected]>2017-10-05 20:09:21 +0200
committerGitHub <[email protected]>2017-10-05 20:09:21 +0200
commit2cc4765670b27f74f68e1614b1763a7819e02854 (patch)
tree103614984fa0ed7bcbde5cf5da5b6c8730dace61 /CONTRIBUTING.md
parent856fc445dac9fe19c8eeaeb2504bf59b04f2f6af (diff)
downloadhugo-2cc4765670b27f74f68e1614b1763a7819e02854.tar.gz
hugo-2cc4765670b27f74f68e1614b1763a7819e02854.zip
Add mage installation step to CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3b4ee6329..1ef37a69d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -145,7 +145,13 @@ started:
### Build Hugo with Your Changes
-**Note:** Hugo uses [mage](https://github.com/magefile/mage) to build.
+**Note:** Hugo uses [mage](https://github.com/magefile/mage) to build. To install `mage` run
+
+```bash
+go get github.com/magefile/mage
+```
+
+`mage -l` lists all available commands with the corresponding description. To build Hugo run
```bash
cd $HOME/go/src/github.com/gohugoio/hugo