Updating Docs.

mrmrs · mrmrs · commit 56e9f570c1ae · 2013-03-14T00:42:38.000-07:00
diff --git a/README.md b/README.md
@@ -1,32 +1,45 @@
 # NKD
 
-Barebones scaffolding for a new HTML5 Jekyll project. 
+## Barebones scaffolding for a new Responsive HTML5 Jekyll project. 
 
+You shouldn't have to create a bunch of files to get going. Everything should just work. NKD just works.
+Start developing your jekyll prototype without any of the boring setup fuss.
+
+Site structure is as follows:
+
+<pre>
 nkd                               [Site root]
 ├── README.md                     [What you're reading now]
 ├── Rakefile                      [Rake sass, rake dev]
 ├── _config.yml                   [Config for site. Site will run without config in defulat mode]
 ├── _includes                     [Common includes I need for sites / pages]
-│   ├── _footer.html
-│   ├── _head.html
-│   ├── _js_includes.html
-│   └── _navigation_main.html
+│   ├── _footer.html              [_BLANK_]
+│   ├── _head.html                [Common header elements]
+│   ├── _js_includes.html         [_BLANK_]
+│   └── _navigation_main.html     [_BLANK_]
 ├── _layouts                      [Two layout files: default and post. both are identical by default.]
-│   ├── default.html
+│   ├── default.html      
 │   └── post.html
 ├── _posts                        [Directory where you'd put posts...if you want any]
 ├── _sass
 │   ├── _grid.scss                [Blank media queries. Not included or compiled to css]
-│   ├── i.scss
+│   ├── i.scss                    [Includes normalize - compiles to i.css]
 │   └── normalize.scss            
-├── _site                         [compiled website]
-│   ├── README.md
-│   ├── Rakefile
-│   ├── css
-│   │   ├── i.css
-│   │   └── normalize.css
-│   └── index.html
 ├── css
 │   ├── i.css
-│   └── normalize.css
-└── index.html
+└── index.html                    [index file that's served up at root. The "homepage" if you will.]
+</pre>
+
+As you can see a number of files are blank and not included by default. These are common assets I need to use. 
+
+
+## Rake Tasks
+
+### rake dev
+    jekyll --auto --server
+Use this to start the jekyll server. It will auto generate a new site at _site every time you save a file.
+
+
+### rake sass
+    sass --watch _sass:css
+Run this to start the sass autocompiler. Compiles to /nkd/css/i.css on save.
