Revise README.md emphasizing "good commit message" - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit 447228a742ede4a6d9aeb0c5b4eac8f7af74bd92
DIR parent 8f368114d3ff5e778aba9b4daeb2af41d6166b7a
HTML Author: Anthony Fok <foka@debian.org>
Date: Fri, 5 Feb 2016 12:34:40 +0800
Revise README.md emphasizing "good commit message"
plus some trivial changes.
Diffstat:
M README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
---
DIR diff --git a/README.md b/README.md
@@ -76,7 +76,7 @@ Use the [installation instructions in the Hugo documentation](http://gohugo.io/o
6. Use a symbolic link to add your locally cloned Hugo repository to your `$GOPATH`, assuming you prefer doing development work outside of `$GOPATH`:
- ``` bash
+ ```bash
rm -rf "$GOPATH/src/github.com/spf13/hugo"
ln -s `pwd` "$GOPATH/src/github.com/spf13/hugo"
```
@@ -103,7 +103,7 @@ The Hugo community and maintainers are very active and helpful and the project b
[](https://waffle.io/spf13/hugo/metrics)
-If you have any questions about how to contribute or what to contribute please ask on the [forum](http://discuss.gohugo.io).
+If you have any questions about how to contribute or what to contribute, please ask on the [forum](http://discuss.gohugo.io).
## Code Contribution Guideline
@@ -116,12 +116,12 @@ To make the process as seamless as possible, we ask for the following:
* 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.
- * This [blog article](http://chris.beams.io/posts/git-commit/) is a good resource for learning how to write good commit messages, the most important part being that each commit message should have a title/subject in imperative mood starting with a capital letter and no trailing period: *"Return error on wrong use of the Paginator"*, **NOT** *"returning some error."* Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*. Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*.
- * Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) (Linux) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing.
+ * **Write a good commit message.** This [blog article](http://chris.beams.io/posts/git-commit/) is a good resource for learning how to write good commit messages, the most important part being that each commit message should have a title/subject in imperative mood starting with a capital letter and no trailing period: *"Return error on wrong use of the Paginator"*, **NOT** *"returning some error."* Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*. Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*.
+ * Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) (Linux and OS X) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing.
### Build Hugo with Your Changes
-``` bash
+```bash
cd /path/to/hugo
go build -o hugo main.go
mv hugo /usr/local/bin/
@@ -141,7 +141,7 @@ Alternatively, just run `make` — all the “magic” above is already in t
### Run Hugo
-``` bash
+```bash
cd /path/to/hugo
go install github.com/spf13/hugo/hugolib
go run main.go