From 7f616c0cca7129590820ed85a04ce4332d1222d2 Mon Sep 17 00:00:00 2001 From: Jim Perrin Date: Jan 23 2014 23:12:24 +0000 Subject: readme update --- diff --git a/README.md b/README.md index 28b475a..6808444 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,23 @@ Installing on Fedora 20: sudo yum install ruby asciidoc nokogiri gem install nanoc adsf cri compass haml kramdown pry rainpress rubypants sass susy systemu + +#Site Layout + * Template and menu files live in /layouts + * Markdown, erb and processed text files live in /content + * Static site content such as images and javascript live in /static + * The /lib directory contains nanoc helper files used to process the site + * Compiled site content exists in /output + +#Building the site + * Run 'nanoc' to compile assemble the static site. files from /static, /content, and /layouts will be combined. + * You may view the site with 'nanoc view' and then pointing your browser at http://127.0.0.1:3000 + +You may compile and view the site live as you make changes using the guard module. To do this, run 'guard init' at the root of the site. +This will create a watch file that will serve as list for what files the guard module will keep an eye on. Changes to these files will trigger an automatic rebuild of the site. +Next run 'nanoc view &', followed by 'guard' +Now in another terminal, you may make changes to the website content, and it will rebuild as you touch files. + + +#Deploying the site +Simply run 'nanoc deploy --target=' where the target value is either prod1 or prod2. These targets are defined in the nanoc.yaml file.