README.md in sprite-0.1.1 vs README.md in sprite-0.1.2
- old
+ new
@@ -88,13 +88,14 @@
Configuration of `sprite` is done via `config/sprite.yml`. It allows you to set sprite configuration options, and fine tune exactly which sprites get generated where.
* `config:` section defines all the global properties for sprite generation. Such as how it generates the styles, where it looks for images, where it writes it output file to, and what image file format it uses by default
- `style:` defines how the style rules are outputted. built in options are `css`, `sass`, and `sass_mixin`. (defaults to `css`)
- - `output_path:` defines the file path where your style settings get written (defaults to `public/stylesheets/sprites`). the file extension not needed as it will be set based on the `style:` setting
- - `image_output_path:` defines the folder path where the combined sprite images files are written (defaults to `public/images/sprites/`)
- - `source_path:` defines the folder where source image files are read from (defaults to `public/images/`)
+ - `style_output_path:` defines the file path where your style settings get written (defaults to `stylesheets/sprites`). the file extension not needed as it will be set based on the `style:` setting
+ - `image_output_path:` defines the folder path where the combined sprite images files are written (defaults to `images/sprites/`)
+ - `image_source_path:` defines the folder where source image files are read from (defaults to `images/`)
+ - `public_path:` defines the root folder where static assets live (defaults to `public/`)
- `sprites_class:` defines the class name that gets added to all sprite stylesheet rules (defaults to `sprites`)
- `default_format:` defines the default file image format of the generated files. (defaults to `png`)
- `class_separator:` used to generated the class name by separating the image name and sprite name (defaults to `-`)
* `images:` section provides an array of configurations which define which image files are built, and where they get their sprites from. each image setup provides the following config options:
@@ -102,20 +103,21 @@
- `sources:` defines a list of source image filenames to build the target image from (required). They are parsed by <code>Dir.glob</code>
- `align:` defines the composite gravity type, horizontal or vertical. (defaults to `vertical`)
- `spaced_by:` spacing (in pixels) between the combined images. (defaults to `0`)
- `format:` define what image file format gets created (optional, uses `default_format` setting if not set)
-you can define any number of destination image files.
+All image and style paths should be set relative to the public folder (which is configurable via public_path setting).
### Sample Configuration `config/sprite.yml` ###
# defines the base configuration options (file paths, etc, default style, etc)
config:
style: css
- output_path: public/sass/mixins/sprites.sass
- image_output_path: public/images/sprites/
- source_path: public/images/
+ style_output_path: sass/mixins/sprites.sass
+ image_output_path: images/sprites/
+ image_source_path: images/
+ public_path: public/
sprites_class: 'sprites'
class_separator: '-'
default_format: png
# defines what sprite collections get created