ref: 0d63bf00c3bdb4535c4cd2f002a18eb8e6f7c68e
parent: 3ec920ac0f4348d8039e51aed9c9a8ab813a5511
author: Steve Francia <[email protected]>
date: Thu Jul 4 20:35:11 EDT 2013
better install instructions and fixing usage typo
--- a/README.md
+++ b/README.md
@@ -19,14 +19,21 @@
## Installing Hugo
+Hugo is written in GoLang with support for Windows, Linux, FreeBSD and OSX.
+
+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.
+
Installation is very easy. Simply download the appropriate version for your
-platform. Hugo is written in GoLang with support for Windows, Linux and OSX.
+platform. 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.
-Please make sure that you place the executable in your path. `/usr/local/bin`
+Ideally you should install it somewhere in your path for easy use. `/usr/local/bin`
is the most probable location.
-Hugo doesn't have any external dependencies, but can benefit from external
-programs.
+*Hugo has no external dependencies.*
## Installing from source
@@ -127,7 +134,7 @@
$ hugo
> X pages created
- > Y indicies created
+ > Y indexes created
If you are working on things and want to see the changes
@@ -403,9 +410,9 @@
* Hugo now includes a simple server
* First public release
* **0.6.0** July 2, 2013
- * Hugo includes an example documentation site which it builds
+ * Hugo includes an [example documentation site](http://hugo.spf13.com) which it builds
* **0.5.0** June 25, 2013
- * Hugo is quite usable and able to build spf13.com
+ * Hugo is quite usable and able to build [spf13.com](http://spf13.com)
## Roadmap
In no particular order, here is what I'm working on:
--- a/docs/content/doc/installing.md
+++ b/docs/content/doc/installing.md
@@ -2,21 +2,24 @@
"title": "Installing Hugo",
"Pubdate": "2013-07-01"
}
+Hugo is written in GoLang with support for Windows, Linux, FreeBSD and OSX.
+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.
+
Installation is very easy. Simply download the appropriate version for your
-platform.
+platform. 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.
-Hugo is written in GoLang with support for Windows, Linux and OSX.
-
-<div class="alert alert-info">
-Please make sure that you place the executable in your path. `/usr/local/bin`
+Ideally you should install it somewhere in your path for easy use. `/usr/local/bin`
is the most probable location.
-</div>
+*Hugo has no external dependencies.*
-Hugo doesn't have any external dependencies, but can benefit from external
-programs.
-
+Installation is very easy. Simply download the appropriate version for your
+platform.
## Installing from source
--- a/docs/content/doc/usage.md
+++ b/docs/content/doc/usage.md
@@ -15,7 +15,7 @@
-p="": filesystem path to read files relative from
-w=false: watch filesystem for changes and recreate as needed
-s=false: a (very) simple webserver
- -p="1313": port for webserver to run on
+ -port="1313": port for webserver to run on
## Common Usage Example:
@@ -25,7 +25,7 @@
$ hugo
> X pages created
- > Y indicies created
+ > Y indexes created
If you are working on things and want to see the changes