phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-02 23:30:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: how to compile on mac, fix minor errors

Browse source
This commit is contained in:
Alex Dunn 2015-04-04 11:17:19 -07:00 committed by bep
parent beb66c19a4
commit 9de78aab3f
1 changed files with 95 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
docs/content/tutorials/installing-on-mac.md
View file

@ -28,15 +28,25 @@ There's no "best" way to do this. You should use the method that works best for
There are pros and cons for each.
1. `Brew` is the simplest and least work to maintain. The drawbacks aren't severe. The package will be for the most recent release, so it will not have bug-fixes until the next release. The release to `brew` may lag a few days behind because it has to be coordinated with another team. Still, I'd recommend `brew` if you want to work from a stable, widely used source. It works well and is really easy to update.
1. `Brew` is the simplest and least work to maintain. The drawbacks
aren't severe. The default package will be for the most recent
release, so it will not have bug-fixes until the next release
(unless you install it with the `--HEAD` option). The release to
`brew` may lag a few days behind because it has to be coordinated
with another team. Still, I'd recommend `brew` if you want to work
from a stable, widely used source. It works well and is really easy
to update.
2. Downloading the tarball and installing from it is also easy. You have to have a few more command line skills. Updates are easy, too. You just repeat the process with the new binary. This gives you the flexibility to have multiple versions on your computer. If you don't want to use `brew`, then the binary is a good choice.
3. Compiling from source is the most work. The advantage is that you don't have to wait for a release to add features or bug fixes. The disadvantage is that you need to spend more time managing the setup. It's not a lot, but it's more than with the other two options.
Since this is a "beginner" how-to, I'm going to cover the first two options in detail and gloss over the third. There are other documents on the Hugo web site that explain how to build from the sources.
Since this is a "beginner" how-to, I'm going to cover the first two
options in detail and go over the third more quickly.
# Brew
## Brew
## Step 1: Install `brew` if you haven't already
### Step 1: Install `brew` if you haven't already
Go to the `brew` website, http://brew.sh/, and follow the directions there. The most important step is:
@ -48,6 +58,9 @@ When I did this, I had some problems with directory permissions. Searches on Goo
## Step 2: Run the `brew` command to install `hugo`
Replace `brew install hugo` with `brew install hugo --HEAD` if you
want the absolute latest version—there might be bugs!
```
$ brew install hugo
==> Downloading https://homebrew.bintray.com/bottles/hugo-0.13_1.yosemite.bottle.tar.gz
@ -64,7 +77,7 @@ $ which hugo
/usr/local/bin/hugo
$ # show the installed version
$ ll $( which hugo )
$ ls -l $( which hugo )
lrwxr-xr-x 1 mdhender admin 30 Mar 28 22:19 /usr/local/bin/hugo -> ../Cellar/hugo/0.13_1/bin/hugo
$ # verify that hugo runs correctly
@ -72,35 +85,43 @@ $ hugo version
Hugo Static Site Generator v0.13 BuildDate: 2015-03-09T21:34:47-05:00
```
## Step 3: You're Done
### Step 3: You're Done
You've installed Hugo. Now you need to set up your site. Please visit the Hugo documents to learn how to do that.
You've installed Hugo. Now you need to set up your site. Read the
[Quickstart guide](/overview/quickstart/), explore the rest of the
documentation, and if you still have questions
[just ask!](http://discuss.gohugo.io/ "Discussion forum")
# From Tarball
## From Tarball
## Step 1: Decide on the location
### Step 1: Decide on the location
When installing from the tarball, you have to decide if you're going to install the binary in `/usr/local/bin` or in your home directory. There are three camps on this:
1. Install it in `/usr/local/bin` so that all the users on your system have access to it. This is a good idea because it's a fairly standard place for exectuables. The downside is that you may need elevated privileges to put software into that location. Also, if there are multiple users on your system, they will all run the same version. Sometimes this can be an issue if you want to try out a new release.
2. Install it in `~/bin` so that only you can execute it. This is a good idea becase it's easy to do, easy to maintain, and doesn't require elevated privileges. The downside is that only you can run Hugo. If there are other users on your site, they have to maintain their own copies. That can lead to people running different versions. of course, this does make it easier for you to experiment with different releases.
3. Install it in your `sites` directory. This is not a bad idea if you have only one site that you're building. It keeps every thing in a single place. If you want to try out new releases, you can just make a copy of the entire site, update the Hugo executable, and have it.
All three locations will work for you. I'm going to document the second option, mostly because I'm comfortable with it.
## Step 2: Download the Tarball
### Step 2: Download the Tarball
1. Open <https://github.com/spf13/hugo/releases> in your browser.
1. Open `https://github.com/spf13/hugo/releases` in your browser.
2. Find the current release by scrolling down and looking for the green tag that reads "Latest Release."
3. Download the current tarball for the Mac. The name will be something like `hugo_X.YY_darwin_amd64.zip`, where `X.YY` is the release number.
4. By default, the tarball will be saved to your `~/Downloads` directory. If you chose to use a different location, you'll need to change that in the following steps.
## Step 3: Confirm your download
### Step 3: Confirm your download
Verify that the tarball wasn't corrupted during the download:
```
$ tar tvf ~/Downloads/hugo_0.13_darwin_amd64.zip
$ tar tvf ~/Downloads/hugo_0.13_darwin_amd64.zip
-rwxrwxrwx 0 0 0 0 Feb 22 04:02 hugo_0.13_darwin_amd64/hugo_0.13_darwin_amd64
-rwxrwxrwx 0 0 0 0 Feb 22 03:24 hugo_0.13_darwin_amd64/README.md
-rwxrwxrwx 0 0 0 0 Jan 30 18:48 hugo_0.13_darwin_amd64/LICENSE.md
@ -118,20 +139,20 @@ $ # make it the working directory
$ cd ~/bin
$ # extract the tarball
$ unzip ~/Downloads/hugo_0.13_darwin_amd64.zip
$ unzip ~/Downloads/hugo_0.13_darwin_amd64.zip
Archive: hugo_0.13_darwin_amd64.zip
inflating: hugo_0.13_darwin_amd64/hugo_0.13_darwin_amd64
inflating: hugo_0.13_darwin_amd64/README.md
inflating: hugo_0.13_darwin_amd64/LICENSE.md
inflating: hugo_0.13_darwin_amd64/hugo_0.13_darwin_amd64
inflating: hugo_0.13_darwin_amd64/README.md
inflating: hugo_0.13_darwin_amd64/LICENSE.md
$ ll
$ ls -l
total 7704
lrwxr-xr-x 1 mdhender staff 22 Sep 29 13:34 hugo -> hugo_0.12_darwin_amd/hugo_0.12_darwin_amd64
drwxr-xr-x@ 1 mdhender staff 102 Sep 1 14:17 hugo_0.12_darwin_amd64
drwxrwxr-x@ 5 mdhender staff 170 Mar 28 22:46 hugo_0.13_darwin_amd64
-rw-r-----@ 1 mdhender staff 3942651 Mar 28 22:45 hugo_0.13_darwin_amd64.zip
$ ll hugo_0.13_darwin_amd64
$ ls -l hugo_0.13_darwin_amd64
total 27560
-rw-r--r--@ 1 mdhender staff 2707 Jan 30 18:48 LICENSE.md
-rw-r--r--@ 1 mdhender staff 6748 Feb 22 03:24 README.md
@ -144,7 +165,7 @@ I was already running Hugo v0.12, so you can see how that was set up. It'll be i
$ # create the link to the real executable
$ rm -f hugo
$ ln -s hugo_0.13_darwin_amd64/hugo_0.13_darwin_amd64 hugo
$ ll
$ ls -l
total 7704
lrwxr-xr-x 1 mdhender staff 22 Mar 28 22:49 hugo -> hugo_0.13_darwin_amd/hugo_0.12_darwin_amd64
drwxr-xr-x@ 1 mdhender staff 102 Sep 1 14:17 hugo_0.12_darwin_amd64
@ -179,6 +200,58 @@ Then save the file by pressing Control-X, then Y to save the file and return to
Close the terminal and then open a new terminal to pick up the changes to your profile. Verify by running the `which hugo` command again.
## Step 5: You're Done
### Step 5: You're Done
You've installed Hugo. Now you need to set up your site. Please visit the Hugo documents to learn how to do that.
You've installed Hugo. Now you need to set up your site. Read the
[Quickstart guide](/overview/quickstart/), explore the rest of the
documentation, and if you still have questions
[just ask!](http://discuss.gohugo.io/ "Discussion forum")
## Building from Source
If you want to compile Hugo yourself, you'll need
[Go](http://golang.org), which is also available from Homebrew: `brew
install go`.
### Step 1: Get the Source
If you want to compile a specific version, go to
<https://github.com/spf13/hugo/releases> and download the source code
for the version of your choice. If you want to compile Hugo with all
the latest changes (which might include bugs), clone the Hugo
repository:
```
git clone https://github.com/spf13/hugo
```
### Step 2: Compiling
Make the directory containing the source your working directory, then
fetch Hugo's dependencies:
```
mkdir -p src/github.com/spf13
ln -sf $(pwd) src/github.com/spf13/hugo
# set the build path for Go
export GOPATH=$(pwd)
go get
```
This will fetch the absolute latest version of the dependencies, so if
Hugo fails to build it may be because the author of a dependency
introduced a breaking change.
Then compile:
```
go build -o hugo main.go
```
Then place the `hugo` executable somewhere in your `$PATH`.
### Step 3: You're Done
You probably know where to go from here.