diff --git a/README.md b/README.md index 7428f8c58..f5792bf18 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # Hugo -A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com/) and [friends](https://github.com/spf13/hugo/graphs/contributors) in Go. +A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com/) and [friends](https://github.com/spf13/hugo/graphs/contributors) in [Go][]. [![Build Status](https://travis-ci.org/spf13/hugo.png)](https://travis-ci.org/spf13/hugo) [![wercker status](https://app.wercker.com/status/1a0de7d703ce3b80527f00f675e1eb32 "wercker status")](https://app.wercker.com/project/bykey/1a0de7d703ce3b80527f00f675e1eb32) [![Build status](https://ci.appveyor.com/api/projects/status/n2mo912b8s2505e8/branch/master?svg=true)](https://ci.appveyor.com/project/spf13/hugo/branch/master) ## Overview -Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full HTML website. +Hugo is a static site generator written in [Go][]. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full HTML website. -Hugo relies on Markdown files with front matter for meta data. And you can run Hugo from any directory. This works well for shared hosts and other systems where you don't have a privileged account. +Hugo relies on Markdown files with front matter for meta data. And you can run Hugo from any directory. This works well for shared hosts and other systems where you don’t have a privileged account. Hugo renders a typical website of moderate size in a fraction of a second. A good rule of thumb is that each piece of content renders in around 1 millisecond. @@ -15,7 +15,9 @@ Hugo is meant to work well for any kind of website including blogs, tumbles and #### Supported Architectures -Currently Hugo exists for Windows, Linux, FreeBSD and OS X for x64 and i386 architectures. +Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD and OS X for x64 and i386 architectures. + +Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for ARM architecture and for other operating systems including DragonFly BSD, NetBSD, OpenBSD, Plan 9 and Solaris. **Complete documentation is available at [Hugo Documentation](http://gohugo.io/).** @@ -28,29 +30,37 @@ To contribute to the Hugo source code or documentation, you should fork the Hugo Finally, you can install the Hugo source code with `go`, build the binaries yourself, and run Hugo that way. Building the binaries is an easy task for an experienced `go` getter. ### Install Hugo as Your Site Generator (Binary Install) + Use the [installation instructions in the Hugo documentation](http://gohugo.io/overview/installing/). ### Clone the Hugo Project (Contributor) + 1. Make sure your local environment has the following software installed: - * Git - * Go 1.3+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090)) - * Mercurial - * Bazaar -2. Fork the Hugo project on Github. -3. Clone your fork. - `git clone https://github.com/YOURNAME/hugo` -4. Change into the `hugo` directory. + * [Git](http://git-scm.com/) + * [Mercurial](http://mercurial.selenic.com/) + * [Go][] 1.3+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090)) - `cd hugo` -5. Install the Hugo project’s package dependencies. +2. Fork the [Hugo project on GitHub](https://github.com/spf13/hugo). - `go get` -6. Use a symbolic link to add Hugo to your `$GOPATH`. +3. Clone your fork: - `ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo` + git clone https://github.com/YOURNAME/hugo - Go expects all of your libraries to be found in`$GOPATH`. +4. Change into the `hugo` directory: + + cd hugo + +5. Install the Hugo project’s package dependencies: + + go get -u -v github.com/spf13/hugo + +6. Use a symbolic link to add your locally cloned Hugo repository to your `$GOPATH`, assuming you prefer doing development work outside of `$GOPATH`: + + rm -rf "$GOPATH/src/github.com/spf13/hugo" + ln -s `pwd` "$GOPATH/src/github.com/spf13/hugo" + + Go expects all of your libraries to be found in`$GOPATH`. ### Build and Install the Binaries from Source (Advanced Install) @@ -65,6 +75,7 @@ To update Hugo’s dependencies, use `go get` with the `-u` option. go get -u -v github.com/spf13/hugo ## Contributing Code + Contributors should build Hugo and test their changes before submitting a code change. ### Building Hugo with Your Changes @@ -89,7 +100,7 @@ This will result in `hugo version` output that looks similar to: Hugo Static Site Generator v0.13-DEV-8042E77 buildDate: 2014-12-25T03:25:57-07:00 -The format of the date is configurable via the `Params.DateFormat` setting. `DateFormat` is a string value representing the Go time layout that should be used to format the date output. If `Params.DateFormat` is not set, `time.RFC3339` will be used as the default format. See Go's ["time" package documentation](http://golang.org/pkg/time/#pkg-constants) for more information. +The format of the date is configurable via the `Params.DateFormat` setting. `DateFormat` is a string value representing the Go time layout that should be used to format the date output. If `Params.DateFormat` is not set, `time.RFC3339` will be used as the default format. See Go’s ["time" package documentation](http://golang.org/pkg/time/#pkg-constants) for more information. Configuration setting using config.yaml as example: @@ -101,6 +112,8 @@ Will result in: Hugo Static Site Generator v0.13-DEV buildDate: 2014-10-16 Hugo Static Site Generator v0.13-DEV-24BBFE7 buildDate: 2014-10-16 +Alternatively, just run `make` — all the “magic” above is already in the `Makefile`. :wink: + ### Running Hugo cd /path/to/hugo @@ -112,13 +125,15 @@ Will result in: We welcome your contributions. To make the process as seamless as possible, we ask for the following: * Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes. -* When you're ready to create a pull request, be sure to: +* When you’re ready to create a pull request, be sure to: * Have test cases for the new code. If you have questions about how to do it, please ask in your pull request. * Run `go fmt` - * Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. - * Make sure `go test ./...` passes, and `go build` completes. Our Travis CI loop will catch most things that are missing. The exception: Windows. We run on Windows from time to time, but if you have access, please check on a Windows machine too. + * Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request. + * Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) will catch most things that are missing. The exception: Windows. We run on Windows from time to time, but if you have access, please check on a Windows machine too. **Complete documentation is available at [Hugo Documentation](http://gohugo.io/).** [![Analytics](https://ga-beacon.appspot.com/UA-7131036-6/hugo/readme)](https://github.com/igrigorik/ga-beacon) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/spf13/hugo/trend.png)](https://bitdeli.com/free "Bitdeli Badge") + +[Go]: http://golang.org/ diff --git a/docs/content/overview/installing.md b/docs/content/overview/installing.md index 0c9b69676..e74e69900 100644 --- a/docs/content/overview/installing.md +++ b/docs/content/overview/installing.md @@ -11,15 +11,18 @@ title: Installing Hugo weight: 20 --- -Hugo is written in Go with support for multiple platforms. +Hugo is written in [Go][] with support for multiple platforms. The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases). -We currently build for  Windows, +We currently provide pre-built binaries for + Windows,  Linux,  FreeBSD and  OS X for x64 and i386 architectures. +Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for ARM architecture and for other operating systems including DragonFly BSD, NetBSD, OpenBSD, Plan 9 and Solaris. See http://golang.org/doc/install/source for the full set of supported combinations of target operating systems and compilation architectures. + ## Installing Hugo (binary) Installation is very easy. Simply download the appropriate version for your @@ -49,12 +52,11 @@ placed in your `PATH`. ## Installing from source -### Dependencies +### Prerequisite tools for downloading and building source code -* Git -* Go 1.1+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090)) -* Mercurial -* Bazaar +* [Git](http://git-scm.com/) +* [Mercurial](http://mercurial.selenic.com/) +* [Go][] 1.3+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090)) ### Get directly from GitHub @@ -73,3 +75,5 @@ You may run `go get` with the `-u` option to update Hugo's dependencies: ## Contributing Please see the [contributing guide](/doc/contributing/). + +[Go]: http://golang.org/