diff options
author | spf13 <steve.francia@gmail.com> | 2013-07-24 11:43:23 -0400 |
---|---|---|
committer | spf13 <steve.francia@gmail.com> | 2013-07-24 11:43:23 -0400 |
commit | 16b1f284cae7abda49c951394c2284a2dba306ed (patch) | |
tree | 37563b0e5caf313f8915c5e78f89ffc3a8b45b69 /README.md | |
parent | f2e4c9d7093f79d4b7382c9035221a3f6eaccdef (diff) |
Improving installation instructions
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 37 |
1 files changed, 19 insertions, 18 deletions
@@ -25,55 +25,56 @@ The latest release can be found at [hugo releases](https://github.com/spf13/hugo We currently build for Windows, Linux, FreeBSD and OS X for x64 and 386 architectures. +## Installing Hugo (binary) + Installation is very easy. Simply download the appropriate version for your -platform. Once downloaded it can be run from anywhere. You don't need to install +platform from [hugo releases](https://github.com/spf13/hugo/releases). +Once downloaded it can be run from anywhere. You don't need to install it into a global location. This works well for shared hosts and other systems where you don't have a privileged account. -Ideally you should install it somewhere in your path for easy use. `/usr/local/bin` +Ideally you should install it somewhere in your path for easy use. `/usr/local/bin` is the most probable location. -*Hugo has no external dependencies.* +*the Hugo executible has no external dependencies.* ## Installing from source -<<<<<<< HEAD ### Dependencies -Make sure you have a recent version of go installed. Hugo requires go 1.1+. - -**Due to packaging dependencies the following are also required: Git, Bazaar, Mercurial** - -### Cloning and Installing dependencies - -Pre-requisites: - * Git * Go 1.1+ * Mercurial * Bazaar -### Getting locally (for contributors): +### Clone locally (for contributors): - # clone and build git clone https://github.com/spf13/hugo cd hugo go get -### Install directly from Github: +Because go expects all of your libraries to be found in either $GOROOT or $GOPATH, +it's helpful to symlink the project to one of the following paths: + + * ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo + * ln -s /path/to/your/hugo $GOROOT/src/pkg/github.com/spf13/hugo + +### Get directly from Github: + +If you don't intend to contribute, it's even easier. go get github.com/spf13/hugo - go build -o hugo main.go ### Running Hugo - cd hugo + cd /path/to/hugo go run main.go ### Building Hugo - cd hugo + cd /path/to/hugo go build -o hugo main.go + mv hugo /usr/local/bin/ ## Source Directory Organization |