ref: df734bc18aec19ede36402dca88e4f95a761aafc
parent: 8b95cab94ce3426681f32c6f07620a3c7d2f572a
author: Mary Anthony <moxieandmore@gmail.com>
date: Sat Jan 31 16:00:18 EST 2015
Tighten README for the sloppy reader Tighten README for the sloppy reader Tighten README for the sloppy reader Fixing heads tigheten markdown tighten markdown tighten markdown tinker with headings tinker with wording fixing period spacing moving the any dir stuff into the feature section tweak overview tweak overview fixed option too fix break:
--- a/README.md
+++ b/README.md
@@ -1,92 +1,79 @@
# 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.
-[](https://travis-ci.org/spf13/hugo)
-[](https://app.wercker.com/project/bykey/1a0de7d703ce3b80527f00f675e1eb32)
-[](https://ci.appveyor.com/project/spf13/hugo/branch/master)
+[](https://travis-ci.org/spf13/hugo) [](https://app.wercker.com/project/bykey/1a0de7d703ce3b80527f00f675e1eb32) [](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 makes use of Markdown files with front matter for meta data.
+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.
-A typical website of moderate size can be
-rendered in a fraction of a second. A good rule of thumb is that Hugo
-takes around 1 millisecond for each piece of content.
+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.
-It is written to work well with any
-kind of website including blogs, tumbles and docs.
+Hugo is meant to work well for any kind of website including blogs, tumbles and docs.
-**Complete documentation is available at [Hugo Documentation](http://gohugo.io/).**
+#### Supported Architectures
-# Getting Started
+Currently Hugo exists for Windows, Linux, FreeBSD and OS X for x64 and i386 architectures.
-## Installing Hugo
+**Complete documentation is available at [Hugo Documentation](http://gohugo.io/).**
-Hugo is written in Go with support for Windows, Linux, FreeBSD and OS X.
+## Choose How to Install
-The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
-We currently build for Windows, Linux, FreeBSD and OS X for x64
-and i386 architectures.
+If you want to use Hugo as your site generator, simply install the Hugo binaries. The Hugo binaries have no external dependencies.
-### Installing Hugo (binary)
+To contribute to the Hugo source code or documentation, you should fork the Hugo GitHub project and clone it to your local machine.
-Installation is very easy. Simply download the appropriate version for your
-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.
+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.
-Ideally, you should install it somewhere in your path for easy use. `/usr/local/bin`
-is the most probable location.
+### Install Hugo as Your Site Generator (Binary Install)
+Use the [installation instructions in the Hugo documentation](http://gohugo.io/overview/installing/).
-*The Hugo executable has no external dependencies.*
+### 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.
-### Installing from source
+ `git clone https://github.com/YOURNAME/hugo`
+4. Change into the `hugo` directory.
-#### Dependencies
+ `cd hugo`
+5. Install the Hugo project’s package dependencies.
-* 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
+ `go get`
+6. Use a symbolic link to add Hugo to your `$GOPATH`.
-#### Clone locally (for contributors):
+ `ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo`
- git clone https://github.com/spf13/hugo
- cd hugo
- go get
+ Go expects all of your libraries to be found in`$GOPATH`.
-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:
+### Build and Install the Binaries from Source (Advanced Install)
- * `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`
+Add Hugo and its package dependencies to your go `src` directory.
-#### Get directly from GitHub:
-
-If you only want to build from source, it's even easier:
-
go get -v github.com/spf13/hugo
-Once completed, your may find your new `hugo` (or `hugo.exe`) executable
-sitting inside `$GOPATH/bin/`.
+Once the `get` completes, you should find your new `hugo` (or `hugo.exe`) executable sitting inside `$GOPATH/bin/`.
-You may also run `go get` with the `-u` option to update Hugo’s dependencies:
+To update Hugo’s dependencies, use `go get` with the `-u` option.
go get -u -v github.com/spf13/hugo
-#### Building Hugo
+## Contributing Code
+Contributors should build Hugo and test their changes before submitting a code change.
+### Building Hugo with Your Changes
+
cd /path/to/hugo
go build -o hugo main.go
mv hugo /usr/local/bin/
-##### Adding compile information to Hugo
+### Adding compile information to Hugo
When Hugo is built using the above steps, the `version` sub-command will include the `mdate` of the Hugo executable, similar to the following:
@@ -102,7 +89,7 @@
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:
@@ -114,22 +101,21 @@
Hugo Static Site Generator v0.13-DEV buildDate: 2014-10-16
Hugo Static Site Generator v0.13-DEV-24BBFE7 buildDate: 2014-10-16
-#### Running Hugo
+### Running Hugo
cd /path/to/hugo
go install github.com/spf13/hugo/hugolib
go run main.go
-#### Contribution Guidelines
+## Contribution Guidelines
-We welcome your contributions. To make the process as seamless as possible, we ask for the following:
+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.
+* 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:
- * Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
+ * 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 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/).**
--
⑨