css_sprite 1.3.1 → 1.3.2

data/README.textile

@@ -1,6 +1,6 @@
 h1. css_sprite
 
-A rails plugin/gem to generate css sprite images automatically.
+automatically css sprite.
 
 *************************************************************************
 
@@ -12,26 +12,43 @@ I have rewritten the plugin. Please check out the gem version >= 1.3.0
 
 h2. Install
 
-css_sprite is dependent on the <code>rmagick</code> gem, please install it first.
-
+css_sprite depends on the <code>rmagick</code> gem, please make sure RMagick is successfully installed on your system.
 
 install css_sprite as a gem:
-<pre><code>
-sudo gem install css_sprite
-</code></pre>
+<pre><code>sudo gem install css_sprite</code></pre>
 
 or install css_sprite as a plugin:
-<pre><code>
-script/plugin install git://github.com/flyerhzm/css_sprite.git
-</code></pre>
+<pre><code>script/plugin install git://github.com/flyerhzm/css_sprite.git</code></pre>
 
 **************************************************************************
 
-h2. Configuration
+h2. Usage
+
+1. create a directory whose name is css_sprite or ends with css_sprite (e.g. widget_css_sprite) under <code>public/images</code> directory
+
+2. if you install the css_sprite as a gem, you should add css_sprite task in Rakefile
+<pre><code>require 'css_sprite'</code></pre>
+If you install it as a plugin, you can skip this step
+
+2. define <code>config/css_sprite.yml</code>, it is not necessary by default.
+
+3. start css_sprite server
+<pre><code>rake css_sprite:start</code></pre>
+
+4. put any images which you need to do the css sprite under the css_sprite directory, then you will see the automatically generated css sprite image and css files.
+
+5. include the stylesheet in your view page
+<pre><code><%= stylesheet_link_tag 'css_sprite' %></code></pre>
+
+You can stop the css_sprite server by <code>rake css_sprite:stop</code>
 
-There is no need to create any configuration if you do not use sass and you do not want any customization.
+Or you can just do the css sprite manually by <code>rake css_sprite:build</code>
 
-But you can create <code>config/css_sprite.yml</code> to define the customization.
+**************************************************************************
+
+h2. Configuration
+
+There is no need to create any configuration by default. If you want to use sass or you want to define common styles for some related classes, you need to define <code>config/css_sprite.yml</code> file.
 
 h3. Examples
 
@@ -46,7 +63,6 @@ suffix:
     line-height: 15px;
     border: 0;
     outline: 0;
-
   icon: |
     text-indent: -9999px;
     cursor: pointer;
@@ -64,36 +80,22 @@ suffix:
     line-height: 15px
     border: 0
     outline: 0
-
   icon: |
     text-indent: -9999px
     cursor: pointer
 </code></pre>
 
-<code>engine</code> defines css (default) or sass to generate.
+<code>engine</code> defines css (default) or sass file to generate.
 <code>suffix</code> defines the customization styles for specified images. 
-The customization above means if suffix of your image filename is button (e.g. post_button.png), it contains the additional style with (outline: 0; border: 0; and so on),
-if suffix of your image filename is icon (e.g. twitter_icon.png), it contains the additional style with (text-indent: -9999px; cursor: pointer)
+The customization above means if your image filename is button suffixed (e.g. post_button.png), the corresponding class .post_button has the additional style with (outline: 0; border: 0; and so on),
+if your image filename is icon suffixed (e.g. twitter_icon.png), the correspondiing class .twitter_icon has the additional style with (text-indent: -9999px; cursor: pointer)
 
 **************************************************************************
 
-h2. Usage
-
-1. create a <code>css_sprite</code> directory or css_sprite suffixed directory (e.g. widget_css_sprite) under <code>public/images/</code>
-
-2. define <code>config/css_sprite.yml</code> or not
-
-3. start css_sprite server <code>rake css_sprite:start</code>
-
-4. put any images you want to do css sprite into the css_sprite directory
+h2. Best Practices
 
-5. then css_sprite image will be automatically generated and css_sprite.css or css_sprite.sass are generated too.
-
-You can stop top the css_sprite server by <code>rake css_sprite:stop</code>
-
-Or you just want to do css sprite manually <code>rake css_sprite:build</code>
+I have written a post "css sprite best practices":http://www.huangzhimin.com/entries/190-css-sprite-best-practices to introduce the idea that the css_sprite gem follows.
 
 **************************************************************************
 
-
 Copyright (c) 2009 [Richard Huang (flyerhzm@gmail.com)], released under the MIT license

data/Rakefile

@@ -15,7 +15,7 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.summary = "css_sprite is a rails plugin/gem to generate css sprite image automatically."
   gemspec.description = "css_sprite is a rails plugin/gem to generate css sprite image automatically."
   gemspec.email = "flyerhzm@gmail.com"
-  gemspec.homepage = "" 
+  gemspec.homepage = "http://github.com/flyerhzm/css_sprite" 
   gemspec.authors = ["Richard Huang"]
   gemspec.files.exclude '.gitignore'
   gemspec.add_dependency 'rmagick'

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.3.2

data/css_sprite.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{css_sprite}
-  s.version = "1.3.1"
+  s.version = "1.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2010-04-02}
+  s.date = %q{2010-04-07}
   s.description = %q{css_sprite is a rails plugin/gem to generate css sprite image automatically.}
   s.email = %q{flyerhzm@gmail.com}
   s.extra_rdoc_files = [
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
      "spec/spec_helper.rb",
      "tasks/css_sprite_tasks.rake"
   ]
-  s.homepage = %q{}
+  s.homepage = %q{http://github.com/flyerhzm/css_sprite}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}

data/tasks/css_sprite_tasks.rake

@@ -1,3 +1,5 @@
+require 'rbconfig'
+
 namespace :css_sprite do  
   desc "build css sprite image once"
   task :build do
@@ -8,7 +10,7 @@ namespace :css_sprite do
   desc "start css sprite server"
   task :start do
     automatic_script = File.join(File.dirname(__FILE__), '..', 'lib', 'automatic.rb')
-    if RUBY_PLATFORM =~ /win|w32/
+    if Config::CONFIG['host_os'] =~ /mswin|mingw/
       exec "start \"css_sprite\" ruby.exe #{automatic_script}"
       puts "css_sprite server started sucessfully."
     else
@@ -29,7 +31,7 @@ namespace :css_sprite do
   
   desc "stop css sprite server"
   task :stop do
-    if RUBY_PLATFORM =~ /win|w32/
+    if Config::CONFIG['host_os'] =~ /mswin|mingw/
       exec "taskkill /im ruby.exe /fi \"Windowtitle eq css_sprite\""
       puts "css_sprite server shutdown sucessfully."
     else

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 1
-  version: 1.3.1
+  - 2
+  version: 1.3.2
 platform: ruby
 authors: 
 - Richard Huang
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 +08:00
+date: 2010-04-07 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,7 +58,7 @@ files:
 - spec/spec_helper.rb
 - tasks/css_sprite_tasks.rake
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/flyerhzm/css_sprite
 licenses: []
 
 post_install_message: