diff options
author | Anthony Fok <foka@debian.org> | 2014-09-03 08:12:26 +0400 |
---|---|---|
committer | spf13 <steve.francia@gmail.com> | 2014-09-08 19:41:10 +0400 |
commit | 5dd3eaabee80cbf92913522364ef52f26f3269cd (patch) | |
tree | 53aef86c5e0108710d3023cde33d005d45a4d5ae /README.md | |
parent | ac78d25240b0aa428c5a46314b0a6a4e0621d69b (diff) |
More proofreading and minor revisions to Hugo docs
Among the various changes, most instances of
{{ template "partials/FILE.html" . }}
were changed to
{{ partial "FILE.html" . }}
Also, in main.go, change "2013" to "2013-14".
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 14 insertions, 14 deletions
@@ -9,9 +9,9 @@ and [friends](http://github.com/spf13/hugo/graphs/contributors) in Go. 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. +templates and renders them into a full HTML website. -Hugo makes use of markdown files with front matter for meta data. +Hugo makes use of Markdown files with front matter for meta data. A typical website of moderate size can be rendered in a fraction of a second. A good rule of thumb is that Hugo @@ -26,21 +26,21 @@ kind of website including blogs, tumbles and docs. ## Installing Hugo -Hugo is written in Go with support for Windows, Linux, FreeBSD and OSX. +Hugo is written in Go with support for Windows, Linux, FreeBSD and OS X. 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 386 architectures. +We currently build for Windows, Linux, FreeBSD and OS X for x64 +and i386 architectures. ### Installing Hugo (binary) 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 +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. *The Hugo executable has no external dependencies.* @@ -60,17 +60,17 @@ is the most probable location. cd hugo go get -Because go expects all of your libraries to be found in either $GOROOT or $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: - * 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 + * `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: +#### Get directly from GitHub: If you only want to build from source, it's even easier. - go get github.com/spf13/hugo + go get -v github.com/spf13/hugo #### Building Hugo @@ -93,7 +93,7 @@ We welcome your contributions. To make the process as seamless as possible, we * 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. + * 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://hugo.spf13.com).** |