## Installing from source
-Building locally (for contributors):
-
- # install go dependencies
- go get github.com/howeyc/fsnotify
- go get github.com/spf13/hugo/hugolib
++<<<<<<< HEAD
+### Dependencies
+
+Make sure you have a recent version of go installed. Hugo requires go 1.1+.
+
+**Due to packaging dependencies the following are also required: Git, Bazaar, Mercurial**
+
+### Cloning and Installing dependencies
+
+ Pre-requisites:
+
+ * Git
+ * Go 1.1+
+ * Mercurial
++* Bazaar
+
++### Getting locally (for contributors):
+
+ # clone and build
git clone https://github.com/spf13/hugo
cd hugo
-Building directly from Github:
+ go get
+ go build -o hugo main.go
+
++### Install directly from Github:
++
++ go get github.com/spf13/hugo
+ go build -o hugo main.go
+
+### Running Hugo
+
+ cd hugo
+ go run main.go
- go get github.com/spf13/hugo
+### Building Hugo
+
+ cd hugo
+ go build -o hugo main.go
## Source Directory Organization
$ hugo --help
usage: hugo [flags] []
- -b="": hostname (and path) to the root eg. http://spf13.com/
- -c="config.json": config file (default is path/config.json)
- -d=false: include content marked as draft
- -h=false: show this help
- -k=false: analyze content and provide feedback
- -p="": filesystem path to read files relative from
- -w=false: watch filesystem for changes and recreate as needed
- -s=false: a (very) simple webserver
- -port="1313": port for webserver to run on
+ -b, --base-url="": hostname (and path) to the root eg. http://spf13.com/
+ -d, --build-drafts=false: include content marked as draft
+ --config="": config file (default is path/config.yaml|json|toml)
+ -h, --help=false: show this help
+ --port="1313": port to run web server on, default :1313
+ -S, --server=false: run a (very) simple web server
+ -s, --source="": filesystem path to read files relative from
+ --uglyurls=false: use /filename.html instead of /filename/
+ -v, --verbose=false: verbose output
+ --version=false: which version of hugo
+ -w, --watch=false: watch filesystem for changes and recreate as needed
- The most common use is probably to run hugo with your current
+ The most common use is probably to run hugo with your current
directory being the input directory.
> Y indexes created
- If you are working on things and want to see the changes
- immediately, tell Hugo to watch for changes. **It will
- recreate the site faster than you can tab over to
+ If you are working on things and want to see the changes
+ immediately, tell Hugo to watch for changes. **It will
+ recreate the site faster than you can tab over to
your browser to view the changes.**
- $ hugo -p ~/mysite -w
+ $ hugo --source ~/mysite --watch
+ Watching for changes. Press ctrl+c to stop
+ 15 pages created
+ 0 tags created
+
+Hugo can even run a server and create your site at the same time!
+ $hugo --server -ws ~/mysite
+ Watching for changes. Press ctrl+c to stop
+ 15 pages created
+ 0 tags created
+ Web Server is available at http://localhost:1313
+ Press ctrl+c to stop
# Layout