Updating readme with changes to Rakefile. Rakefile now includes task to

mrmrs · mrmrs · commit bfd8fb25ea2b · 2013-05-21T00:35:35.000-07:00
minify css.
diff --git a/README.md b/README.md
@@ -2,47 +2,63 @@ Checkout [nkd.cc](http://nkd.cc)
 
 # NKD
 
-## Barebones scaffolding for a new Responsive HTML5 Jekyll project. 
+## Barebones scaffolding for a new Responsive HTML5 Jekyll project *
 
 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              [_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      
-│   └── 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                    [Includes normalize - compiles to i.css]
-│   └── normalize.scss            
-├── css
-│   ├── i.css
-└── index.html                    [index file that's served up at root. The "homepage" if you will.]
+./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              [_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      
+  │   └── 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                    [Includes normalize - compiles to i.css]
+  │   └── normalize.scss            
+  ├── css
+  │   ├── i.css
+  └── index.html                    [index file that's served up at root. The "homepage" if you will.]
 </pre>
 
 ## Rake Tasks
 
 ### rake dev
-    jekyll --auto --server
+```
+  jekyll serve --watch
+```
 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.
+```
+
+Run this to start the sass autocompiler. Outputs to /nkd/css/i.css.
+
+### rake minify
+```
+    sass --watch _sass:css --style compressed
+```
 
 ### rake clean
+```
     rm -rf _site
+```
+
 Run this to delete the _site directory. Use if you don't want to keep generated site locally unless actively developing.
+
+
+Notes:
+* So many buzzwords.
diff --git a/Rakefile b/Rakefile
@@ -3,15 +3,21 @@ require 'rake'
 
 desc "Automatically generate site at :4000 for local dev"
 task :dev do
-  system "jekyll --auto --server"
+  system "jekyll serve --watch"
 end # task :dev
 
 desc "Start Sass so that is compiles to css upon file save"
 task :sass do
   system "sass --watch _sass:css"
 end # task :sass
 
+desc "Start Sass so that is minifies and compiles to nkd/css/i.css upon file save"
+task :minify do
+  system "sass --watch _sass:css --style compressed"
+end # task :minify
+
 desc "Remove _site from directory before committing"
 task :clean do
   system "rm -rf _site"
 end # task :clean
+
