README.md in smallvictories-0.0.11 vs README.md in smallvictories-0.0.12
- old
+ new
@@ -17,21 +17,33 @@
renders all HTML and Liquid files through this, including snippets from the
includes folder.
You don't have to use a layout file if you don't want to, the files will still
be copied to the destination folder.
-
+
+[Sprite Factory](https://github.com/jakesgordon/sprite-factory) looks for image
+files in the sprite folder and generates a single sprite png and sprite
+stylesheet.
+
[Guard LiveReload](https://github.com/guard/guard-livereload) is used to notify
the browser to automatically reload. It needs to be used with
the [LiveReload Safari/Chrome/Firefox extension](http://livereload.com/extensions#installing-sections).
## Installation
```
gem install smallvictories
```
+To use the [Sprite Factory](https://github.com/jakesgordon/sprite-factory) to
+generate Sprite CSS you will need to install image magick which you can do with
+homebrew:
+
+```
+brew install imagemagick
+```
+
## Commands
### Bootstrap
Sets up default files in a folder.
@@ -48,11 +60,11 @@
### Compile
Compile files.
-Renders Sass/CSS, JavaScript/CoffeeScript, HTML/Liquid in the destination
+Renders Sass/CSS, JavaScript/CoffeeScript, HTML/Liquid and Sprite in the destination
folder.
Command: `sv compile`
### Inline
@@ -77,17 +89,20 @@
└── Small Victories
└── Your Site
└── _src
│ ├── _includes
│ │ └── _head.liquid
+ │ ├── _sprite
│ ├── _layout.liquid
- │ ├── application.css
+ │ ├── applscation.css
│ ├── application.js
- │ └── index.liquid
+ │ ├── index.liquid
+ │ └── sprite.css
│
├── _sv_custom.css
├── _sv_custom.js
+ ├── _sv_sprite.png
└── index.html
```
You would then run `sv watch` from within `Your Site` and Small Victories will
watch for changes in `_src` and compile them to the `Your Site` folder.
@@ -135,10 +150,11 @@
+ `destination`: Relative path for where to save final files.
+ `stylesheet`: Main stylesheet (Sass or CSS) to be compiled into destination.
+ `javascript`: Main javascript file (JS or CoffeeScript) to be compiled into destination.
+ `layout`: Liquid layout file to render all other html and liquid files through.
+ `includes`: Directory where liquid rendered should expect to find snippets.
++ `compile_html`: Should Small Victories compile HTML? Default is true.
### Default Configuration
```yaml
source: '_src'
@@ -147,9 +163,10 @@
source_javascript: 'application.js'
destination_stylesheet: '_sv_custom.css'
destination_javascript: '_sv_custom.js'
layout: '_layout.liquid'
includes: '_includes'
+compile_html: true
```
## Building Locally
1. Clone it