Commit graph

160 commits

Author SHA1 Message Date
Bjørn Erik Pedersen
f627903efa
Update README.md 2018-08-29 14:17:47 +02:00
Christian Oliff
c2a6741394 readme: https links to 3rd party sites 2018-08-08 10:07:31 +02:00
Hudson Muff
fca49d6c60 Update README.md
I discovered an inconsistency between the website documentation (https://gohugo.io/getting-started/installing/#source) and this README, for installing from source. I checked them both and the website seems to be newer so I would like to propose updating this README to install Hugo using mage (unless it doesn't really matter).
2018-04-09 18:06:21 +02:00
Bjørn Erik Pedersen
fe40823de0
readme: Update list of "builders" to include myself 2018-01-30 19:56:29 +01:00
Rizky Agung
fdd62eb4c3 Add linebreak to README.md for better readability 2017-10-28 12:57:15 +02:00
Steve Divskinsy
23488f874c Minor README changes 2017-10-05 12:44:43 +02:00
Bjørn Erik Pedersen
2d1bd876cd Update docs versiona and README
Closes #3791
2017-08-10 17:22:32 +02:00
Bjørn Erik Pedersen
a2fb8150c3 Add some README info about the docs repo 2017-07-18 10:50:59 +02:00
Bjørn Erik Pedersen
4aa1239070 Update links to new discuss URL 2017-06-17 10:06:49 +02:00
Bjørn Erik Pedersen
ccb8300d38 Update logo link in README 2017-06-14 11:24:09 +02:00
Bjørn Erik Pedersen
fbb25014e1 Update Gitter link in README
That is still running under spf13.
2017-06-13 23:39:55 +02:00
Bjørn Erik Pedersen
86543d6a50 Change Windows build badge link, take #3 2017-06-13 22:05:39 +02:00
Bjørn Erik Pedersen
3b47805fdd Change Windows build badge link, take #2 2017-06-13 22:04:36 +02:00
Bjørn Erik Pedersen
e6ae32a0ba Update Windows build link 2017-06-13 22:03:05 +02:00
Bjørn Erik Pedersen
93643860c9 Update README to point to gohugoio/hugo 2017-06-13 19:00:10 +02:00
Ricardo N Feliciano
b31da911b5 docs: Properly capitalize GitHub 2017-04-05 18:41:23 +02:00
Anthony Fok
a99661031a docs: Change OS X to macOS in README and CONTRIBUTING 2017-03-15 07:58:58 -06:00
Bjørn Erik Pedersen
63e2a46f63 docs: Add Android to README 2017-03-12 00:52:40 +01:00
digitalcraftsman
e9921ae4b2 docs: Mention Hugo's official twitter account 2017-02-23 22:05:38 +01:00
Cameron Moore
f79877cbb7 Remove waffle.io graph from README
Waffle.io's throughput graph appears to be broken.  Remove the graph and
simply link to GitHub's Pulse page.

Fixes #2865
2017-01-02 11:42:58 +01:00
digitalcraftsman
78e5263ca9 Readme: Clarify usage of Gitter 2016-09-28 14:51:40 +02:00
Anthony Fok
f914774f6b Remove broken Bitdeli badge from README.md 2016-08-16 21:13:21 -06:00
Cameron Moore
373ca66287 hugo: Update contribution guidelines
Refactor the contribution guidelines in the README and CONTRIBUTING
files.

Simplify the contribution guide in the README and move most of the
complex stuff into CONTRIBUTING.

Add an explicit commit message guidelines section to CONTRIBUTING.  Keep
all of the guidelines from Chris Beams except for the 72 character line
limit (we don't follow that, nor does the Go team).  Add three new
guidelines: package prefix in subject, references in body, and
encouragement of message body in general.

Add a new section to CONTRIBUTING on using Git Remotes.
2016-06-16 16:31:22 -05:00
Bjørn Erik Pedersen
c40bc27468 Improve build labels in README 2016-04-15 13:02:03 +02:00
Bjørn Erik Pedersen
4d34a98a28 Add GoDocs badge 2016-04-10 00:14:16 +02:00
Aditya Bhargava
51ee3fc735 docs: Document how to install dependencies for tests
Fixes #919
2016-04-09 13:52:00 +02:00
digitalcraftsman
ac1ec5c72c docs: Remove remaining Mercurial references 2016-04-09 12:40:58 +02:00
digitalcraftsman
ebf3cef162 docs: Add "How to contribute to Hugo" tutorial 2016-04-08 19:18:58 +02:00
Nik Nyby
970f15cf7a docs: Use HTTPS links in README where appropriate 2016-04-08 19:14:08 +02:00
Bjørn Erik Pedersen
27f9e62bb3 Remove Wercker badge
See #2054
2016-04-07 13:28:26 +02:00
Bjørn Erik Pedersen
42b302fc6b Revert "Add Codebeat badge"
Will have to review the rules on this code report  before people start sending PRs based on this.

This reverts commit c50c66879d.
2016-03-17 23:50:42 +01:00
Tomasz Korzeniowski
c50c66879d Add Codebeat badge 2016-03-17 23:28:41 +01:00
Bjørn Erik Pedersen
0ec8fc5490 Add Go Report Card badge to README 2016-03-17 23:24:24 +01:00
Bjørn Erik Pedersen
575ae1b3f9 Remove CircleCI badge for now 2016-03-15 19:04:24 +01:00
Bjørn Erik Pedersen
077b0fa71f Add package prefix to the commit message guidelines 2016-03-11 10:30:17 +01:00
Bjørn Erik Pedersen
253a618854 Go 1.6 is out! 2016-02-17 23:18:54 +01:00
digitalcraftsman
0d415e453b Link Gitter as Dev Chat in README 2016-02-13 12:04:36 +01:00
Anthony Fok
21b0aa8633 Restore the wercker status badge to original small size
Fix my brown paper bag bug in commit a0eec02.
Sorry for not double-checking before pushing!
2016-02-13 18:48:51 +08:00
Anthony Fok
a0eec02bd6 Set the wercker badge to track the aaster branch only 2016-02-13 18:39:38 +08:00
Morton Fox
28e6e19d0a Fix git commit blog article link
The blog article linked in the README misses the trailing forward slash
which produces a 404 error instead of redirecting to the correct URL.
2016-02-10 14:55:25 +01:00
Michael Faille
08670e6a47 Fix README.md to list the correct -ldflags for Go 1.5+
Also remove extraneous trailing space (whitespace-mode from emacs).

See also #1365
2016-02-06 18:25:57 +08:00
Anthony Fok
447228a742 Revise README.md emphasizing "good commit message"
plus some trivial changes.
2016-02-05 12:34:40 +08:00
Anthony Fok
8f368114d3 Update Travis CI status in README.md to track master branch only 2016-02-05 10:15:34 +08:00
Anthony Fok
ce0304a1d1 Change Gitter badge to "gitter | dev chat" in README.md
using the badges-as-a service provided by Shields.io
2016-01-03 03:33:10 -07:00
Steve Francia
de14ceecc9 Update "Join Chat" to "Dev Chat" 2015-12-08 15:10:53 -05:00
kmonsoor
83f19d8d87 fixed documentation link 2015-11-20 10:20:40 -05:00
Bjørn Erik Pedersen
2843605963 Emphasize that commit message titles should start with a capital letter 2015-11-15 17:49:30 +01:00
Billy Burrows
01c87d2d23 Small Doc Changes 2015-11-07 20:13:20 -07:00
Bjørn Erik Pedersen
1758db29f5 Cosmetic change in README to trigger new build 2015-11-07 01:39:10 +01:00
Anthony Fok
6c6905d5f4 Fix missing "]" in README.md in commit 2242712 2015-10-30 14:12:01 -06:00
Anthony Fok
2242712b0c Add CircleCI status badge to README.md
Also, following the example of title="wercker status",
add "title" attribute to the other status badges
in order to show tooltips.
2015-10-30 14:08:21 -06:00
Bjørn Erik Pedersen
6b34a4e4e8 Remove anchor from fork link in README 2015-10-21 10:48:16 +02:00
Bjørn Erik Pedersen
f77279bb00 Turn all README headlines into imperative mode
This also matches the commit guidelines.
2015-10-20 23:16:21 +02:00
Bjørn Erik Pedersen
4974a62c70 Trim down 'Adding Compile Information to Hugo' in README 2015-10-20 21:25:27 +02:00
Ethan Madison
5cf1475ecd Improve README
All-around improvements to the README.
Each sentence now gets its own line to eliminate ultra-long lines in the
source (expect in bullet points--separating a bullet point into multiple
lines looks weird and decreases readability).
HTTPS links are now preferred to HTTP links and used where applicable.
Link to Mercurial's website corrected to www.mercurial-scm.org
Link to Hugo's docs is now accessible with [Hugo Documentatio][] since
it is used more than once in the README.
Multiline code blocks are now fenced rather than indented and include
syntax highlighting.
2015-10-20 20:43:36 +02:00
Steve Francia
0c66ad8775 Add CLA assist to the contribution workflow in README 2015-10-16 17:57:37 -04:00
Gloria Dwomoh
fb0e17a3ed Update README.md 2015-10-16 23:24:35 +02:00
Bjørn Erik Pedersen
c1a60732ae Remove Go 1.3 from README 2015-10-07 21:09:50 +02:00
Anthony Fok
5505ac0d72 doc: Strip trailing whitespace; other revisions
Make some random and non-comprehensive changes to the
template functions documentation to make them more
consistent.
2015-08-04 12:00:08 -06:00
Bjørn Erik Pedersen
da0715a0c5 Remove point 7 in contributors guide
It makes sense on its own, but it contradicts 6). We need to revisit this one to make it more clear/better.
2015-07-24 11:41:45 +02:00
Scott C Wilson
d25cd03994 Make small fixes to README file
- Add a step to Contributor instructions for those modifying commands
- Change forum link to http (https does not work)
- Add "Sign the forum release thread" to contributor instructions
2015-07-24 11:35:20 +02:00
bep
be4a9dd5d2 Remove section about the buildDate being configurable
It isn't.
2015-04-06 16:30:49 +02:00
bep
be25acae28 Fix README part about missing Windows tests
We now have AppVeyor.
2015-04-06 15:15:54 +02:00
bep
be1b7f67d3 Add git commit message guideline
Also rearranged the contribution section to get more attention to the important stuff.
2015-04-06 15:12:01 +02:00
Vitaly Haritonsky
32bf8b763c removed duplicate word in readme 2015-03-14 10:45:50 -06:00
Steve Francia
fb0facefa8 Tidying the Readme a bit more 2015-03-04 09:17:35 -05:00
Steve Francia
6c9bdc2859 Using a smaller Header Image 2015-03-04 09:16:49 -05:00
Steve Francia
8aa646ced2 Fixing image in readme 2015-03-04 09:15:55 -05:00
Steve Francia
1e210a434d Restructure top of Readme.md 2015-03-04 09:15:03 -05:00
The Gitter Badger
45d962c60a Added Gitter badge 2015-03-04 14:06:38 +00:00
Steve Francia
d5cb369556 Update Readme.md with additional contribution guides 2015-03-04 09:01:15 -05:00
Anthony Fok
bb13d82677 [Docs] NetBSD and ARM pre-built binaries are already provided
See https://github.com/spf13/hugo/releases

What a pleasant surprise indeed!
How come I have never noticed them before?

And even `.deb` files are provided!  How amazing!
2015-02-21 23:26:34 -07:00
Anthony Fok
ac189fd514 Update README.md and overview/installing.md
- Clarify that Hugo may be built wherever Go is available;
- Add links to Git, Mercurial and Go;
- Unlist Bazaar: No libraries that Hugo depends on use it any more;
- Suggest the user to simply run `make` to build `hugo`
  to get `hugo version` to display the commit hash.
2015-02-21 13:42:15 -07:00
Anthony Fok
159836ed2d README.me: Add linefeed that got lost in the last commit 2015-02-16 09:07:52 -07:00
Mary Anthony
df734bc18a 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:
2015-02-01 23:15:46 -07:00
Anthony Fok
ba44e860a3 [Docs] Copyediting
* Add meta author, description and generator tags
 * Add Hugo version beside the logo and in the footer
 * Suggest the user to run `go get -u -v` to update dependencies
 * Requires Go 1.3+ rather than Go 1.1+
 * Improve rendering/formatting in some places
 * Add trailing slash to URLs where appropriate
 * GitHub redirects all http requests to https, update accordingly
2015-01-28 18:02:40 -07:00
Derek Perkins
ac6b86aff8 Added top level .Hugo variable with version, commit and generator information + docs
Added Version, CommitHash and BuildDate to hugolib/hugo.go and used it in build
Removed commitHash and buildDate from commands/version.go and used hugolib vars
Removed getDateFormat function from commands/version.go

Conflicts:
	README.md
	docs/content/templates/variables.md
2015-01-19 01:22:23 +01:00
Anthony Fok
5792cc3a1a [Docs] Go 1.4+ required for building on Windows
See Issue #688 for more information.
2014-12-26 13:00:14 -07:00
Anthony Fok
0cfdb2e51b Revise README.md: buildDate expects timezone; copyediting
Since commit 3a8c12418a dated 2014-12-09,
commands.buildDate expects `date +%FT%T%z` rather than `date +%FT%T`.
Update README.md accordingly.

Also did a little copyediting.
2014-12-25 21:46:43 -07:00
spf13
78316903a2 adding appvoyer support for Windows CI integration 2014-11-25 09:01:54 -05:00
Joel Scoble
f037ae7b4f update README.md with info on adding compile information to version 2014-11-13 22:22:15 -05:00
Kartik Singhal
879e90dca7 Switch to new hompage 2014-10-02 13:39:59 -04:00
Anthony Fok
5dd3eaabee 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".
2014-09-08 11:41:10 -04:00
Nate Finch
c02a02070f change golang to go 2014-03-24 14:34:41 -04:00
Tim Heaney
5ee0a3b9a1 Typo: s/executible/executable/ 2014-03-24 14:33:16 -04:00
GuoJing
1b3525d638 fix typo of readme 2014-03-13 12:01:00 +01:00
Steve Francia
c51d040e3d Adding Werker status to readme 2014-01-15 11:06:41 -05:00
Steve Francia
247db151fa Adding some analytics 2014-01-03 12:58:09 -05:00
Noah Campbell
6410965b97 Add go fmt to contribution guidelines
Also fixed up formatting.
2013-12-07 20:51:34 -08:00
Noah Campbell
357ab956ea Add Contribution Guidelines
Fixes #122
2013-12-07 20:48:17 -08:00
Noah Campbell
bb273df4cd Add support for continuous testing.
Using travis-ci.org
2013-08-09 18:34:51 -07:00
spf13
f6e590e536 Fixing link to contributor page on github 2013-08-03 03:33:39 -04:00
spf13
6a1a038c57 Shrinking the readme to just the basics to avoid dupe with doc site 2013-08-03 03:31:25 -04:00
spf13
ddad1e04ac adding previous next capabilities 2013-08-02 16:30:26 -04:00
spf13
dd9a7e6455 Fixing headers in readme 2013-07-24 11:47:58 -04:00
spf13
16b1f284ca Improving installation instructions 2013-07-24 11:43:23 -04:00
spf13
f2e4c9d709 Merge branch 'master' of github.com:spf13/hugo 2013-07-24 11:27:48 -04:00
spf13
3ad3f2f0e0 Merge branch 'doc-fix' of https://github.com/brandonblack/hugo into brandonblack-doc-fix
Conflicts:
	README.md
2013-07-24 11:27:03 -04:00
Brandon Black
580bb9bb5b minor: adding some more instructions for building from source 2013-07-22 14:40:45 -07:00
Steve Francia
2dde27f0dc Update README.md
fixing typo in readme.
2013-07-21 00:51:39 -04:00