From fca49d6c608d227049cb2f26895cfecc685f1c89 Mon Sep 17 00:00:00 2001 From: Hudson Muff Date: Fri, 23 Mar 2018 17:34:45 +0100 Subject: Update README.md I discovered an inconsistency between the website documentation (https://gohugo.io/getting-started/installing/#source) and this README, for installing from source. I checked them both and the website seems to be newer so I would like to propose updating this README to install Hugo using mage (unless it doesn't really matter). --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7353bd464..ff55b809f 100644 --- a/README.md +++ b/README.md @@ -54,15 +54,28 @@ Use the [installation instructions in the Hugo documentation](https://gohugo.io/ ### Build and Install the Binaries from Source (Advanced Install) -Add Hugo and its package dependencies to your go `src` directory. +#### Prerequisite Tools - go get -v github.com/gohugoio/hugo +* [Git](http://git-scm.com/) +* [Go (latest or previous version)](https://golang.org/dl/) -Once the `get` completes, you should find your new `hugo` (or `hugo.exe`) executable sitting inside `$GOPATH/bin/`. +#### Vendored Dependencies -To update Hugo’s dependencies, use `go get` with the `-u` option. +Hugo uses [dep](https://github.com/golang/dep) to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository. Therefore, a simple `go get` is _not_ supported because the command is not vendor aware. - go get -u -v github.com/gohugoio/hugo +The simplest way is to use [mage](https://github.com/magefile/mage) (a Make alternative for Go projects.) + +#### Fetch from GitHub + +```bash +go get github.com/magefile/mage +go get -d github.com/gohugoio/hugo +cd ${GOPATH:-$HOME/go}/src/github.com/gohugoio/hugo +mage vendor +mage install +``` + +**If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`.** ## The Hugo Documentation -- cgit v1.2.3