better install instructions and fixing usage typo

This commit is contained in:
Steve Francia 2013-07-05 00:35:11 -04:00
parent 3ec920ac0f
commit 0d63bf00c3
3 changed files with 32 additions and 22 deletions

View file

@ -19,14 +19,21 @@ kind of website including blogs, tumbles and docs.
## Installing Hugo ## Installing Hugo
Installation is very easy. Simply download the appropriate version for your Hugo is written in GoLang with support for Windows, Linux, FreeBSD and OSX.
platform. Hugo is written in GoLang with support for Windows, Linux and OSX.
Please make sure that you place the executable in your path. `/usr/local/bin` 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. 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`
is the most probable location. is the most probable location.
Hugo doesn't have any external dependencies, but can benefit from external *Hugo has no external dependencies.*
programs.
## Installing from source ## Installing from source
@ -127,7 +134,7 @@ directory being the input directory.
$ hugo $ hugo
> X pages created > X pages created
> Y indicies created > Y indexes created
If you are working on things and want to see the changes If you are working on things and want to see the changes
@ -403,9 +410,9 @@ To check if a parameter has been provided use the isset method provided by Hugo.
* Hugo now includes a simple server * Hugo now includes a simple server
* First public release * First public release
* **0.6.0** July 2, 2013 * **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 * **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 ## Roadmap
In no particular order, here is what I'm working on: In no particular order, here is what I'm working on:

View file

@ -2,22 +2,25 @@
"title": "Installing Hugo", "title": "Installing Hugo",
"Pubdate": "2013-07-01" "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. 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`
is the most probable location.
*Hugo has no external dependencies.*
Installation is very easy. Simply download the appropriate version for your Installation is very easy. Simply download the appropriate version for your
platform. platform.
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`
is the most probable location.
</div>
Hugo doesn't have any external dependencies, but can benefit from external
programs.
## Installing from source ## Installing from source
Make sure you have a recent version of go installed. Hugo requires go 1.1+. Make sure you have a recent version of go installed. Hugo requires go 1.1+.

View file

@ -15,7 +15,7 @@ Make sure either hugo is in your path or provide a path to it.
-p="": filesystem path to read files relative from -p="": filesystem path to read files relative from
-w=false: watch filesystem for changes and recreate as needed -w=false: watch filesystem for changes and recreate as needed
-s=false: a (very) simple webserver -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: ## Common Usage Example:
@ -25,7 +25,7 @@ directory being the input directory.
$ hugo $ hugo
> X pages created > X pages created
> Y indicies created > Y indexes created
If you are working on things and want to see the changes If you are working on things and want to see the changes