groundworkcss 0.4.4 → 2.0.0

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    groundworkcss (2.0.0)
+      autoprefixer-rails (~> 0.7)
+      compass-rails (~> 1)
+      jquery-rails (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    autoprefixer-rails (0.8.20130911)
+      execjs
+    builder (3.1.4)
+    chunky_png (1.2.8)
+    compass (0.12.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    compass-rails (1.0.3)
+      compass (>= 0.12.2, < 0.14)
+    erubis (2.7.0)
+    execjs (2.0.1)
+    fssm (0.2.10)
+    i18n (0.6.5)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    sass (3.2.10)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  groundworkcss!

data/README.md

@@ -1,4 +1,4 @@
-GroundworkCSS Rails Gem
+GroundworkCSS 2 Rails Gem
 ====
 
 
@@ -8,70 +8,136 @@ Add GroundworkCSS to your rails project.
 Inside your Gemfile add the following lines:
 
 ```ruby
+gem 'autoprefixer-rails'
 gem 'compass-rails'
 gem 'groundworkcss'
 ```
 
 Note, you will need to have therubyracer enabled in order to support Coffeescript. Ensure that this line is uncommented in your Gemfile:
-```
+
+```ruby
 gem 'therubyracer', :platforms => :ruby
 ```
 
 Then run `bundle install` to install the gem.
 
-Note from @ghepting: I've noticed that in Rails 4 that `compass-rails` isn't working properly yet, so I've been using the edge version of @milgner's fork, which seems to work well. Use at your own risk.  :)
+**Note from @ghepting:** I've found that `compass-rails` isn't working with Rails 4 quite yet, so I've been using an unofficial edge version. This fork by @milgner seems to work well, so I've setup [a fork on @groundworkcss](https://github.com/groundworkcss/compass-rails) for anyone else who likes to live on the bleeding edge. Use at your own risk.  :)
 
 ```ruby
-gem 'compass-rails', github: 'milgner/compass-rails', ref: '1749c06f15dc4b058427e7969810457213647fb8'
+gem 'compass-rails', github: 'groundworkcss/compass-rails', ref: '1749c06f15dc4b058427e7969810457213647fb8'
 ```
 
 ## Include GroundworkCSS in your manifest file(s):
 
-If you want to include GroundworkCSS on all of your pages then run the following to append `groundworkcss` to your application sprockets files:
+If you want to include Groundwork on all of your pages then run the following generator to include it in your application sprockets files:
 
 ```bash
-$ bundle exec rails g groundworkcss:install
+$ bundle exec rails generate groundworkcss:install
 ```
 
-If necessary, rename `application.css` to `application.scss` to enable Sass compilation.
-
-```bash
-$ mv app/assets/stylesheets/application.{css,scss}
-```
+**Note:** This will automatically rename `application.css` to `application.scss`, if necessary, to enable Sass compilation.
 
-You can also manually include `groundworkcss` on individual pages:
+Alternately, you can manually include groundwork on individual pages/layouts:
 
-```ruby
-stylesheet_link_tag "groundworkcss"
-javascript_include_tag "groundworkcss"
+```html
+<link rel="stylesheet" href="<%= asset_path('groundworkcss/groundwork.css') %>" />
+<script type="text/javascript" src="<%= asset_path('groundworkcss/libs/modernizr-2.6.2.min.js') %>"></script>
+<script type="text/javascript" src="<%= asset_path('groundworkcss/libs/jquery-1.10.2.min.js') %>"></script>
+<script type="text/javascript" src="<%= asset_path('groundworkcss/all.js') %>"></script>
 ```
 
-You can add `require "groundworkcss"` to your javascripts sprockets file(s):
+Or you can include groundwork manually in javascript and stylesheet manifest files:
 
 **in application.js**
 
 ```javascript
-//= require "groundworkcss"
+//= require jquery
+//= require "groundworkcss/libs/modernizr-2.6.2.min"
+//= require "groundworkcss/all"
+```
+
+**in application.scss**
+
+```scss
+@import 'groundworkcss/settings-rails4'; // or 'settings-rails3'
+@import "groundworkcss/groundwork";
+```
+
+## Include the GroundworkCSS docs pages:
+
+If you want to include the GroundworkCSS docs pages in the rails development environment (comes in handy for quick reference and testing installation) then run the following generator (after running the install generator):
+
+```bash
+$ bundle exec rails generate groundworkcss:docs
 ```
 
 ### Advanced
 
-Alternatively, you may be more selective about which modules to use and can selectively add stylesheets and javascripts to your project:
+Alternatively, you may selectively choose which Groundwork modules to be included in your stylesheet and javascript manifest files:
 
-**in application.css**
+**in application.scss**
 
 ```scss
-@import "groundworkcss/groundwork/core/all-core";
-@import "groundworkcss/groundwork/base/all-base";
-@import "groundworkcss/groundwork/type/all-type";
+@import "groundworkcss/groundwork/core/all-core";             // required
+@import "groundworkcss/groundwork/base/all-base";             // required
+@import "groundworkcss/groundwork/icons/all-icons";           // required
+@import "groundworkcss/groundwork/type/all-type";             // recommended
+@import "groundworkcss/groundwork/ui/all-ui";                 // optional
+@import "groundworkcss/groundwork/anim/all-animations";       // optional
+@import "groundworkcss/groundwork/responsive/all-responsive"; // recommended
+```
+
+Expert users may be even more selective, however, it is best to control this level of optimization with the configurations in `_groundwork_settings.scss` as there are several complex dependancy chains that must be understood. Two modules that this can be easily done, however, are `ui` and `anim`.
+
+```scss
+@import "groundworkcss/groundwork/core/all-core";             // required
+@import "groundworkcss/groundwork/base/all-base";             // required
+@import "groundworkcss/groundwork/icons/all-icons";           // required
+@import "groundworkcss/groundwork/type/all-type";             // recommended
+
+// UI Components
+@import "groundworkcss/groundwork/ui/boxes";                  // optional
+@import "groundworkcss/groundwork/ui/buttons";                // optional
+@import "groundworkcss/groundwork/ui/forms";                  // optional
+@import "groundworkcss/groundwork/ui/messages";               // optional
+@import "groundworkcss/groundwork/ui/nav";                    // optional
+@import "groundworkcss/groundwork/ui/tables";                 // optional
+@import "groundworkcss/groundwork/ui/tabs";                   // optional
+
+// Animations
+@import "groundworkcss/groundwork/anim/bounce";               // optional
+@import "groundworkcss/groundwork/anim/fade";                 // optional
+@import "groundworkcss/groundwork/anim/flash";                // optional
+@import "groundworkcss/groundwork/anim/flip";                 // optional
+@import "groundworkcss/groundwork/anim/hinge";                // optional
+@import "groundworkcss/groundwork/anim/lightspeed";           // optional
+@import "groundworkcss/groundwork/anim/pulse";                // optional
+@import "groundworkcss/groundwork/anim/roll";                 // optional
+@import "groundworkcss/groundwork/anim/rotate";               // optional
+@import "groundworkcss/groundwork/anim/shake";                // optional
+@import "groundworkcss/groundwork/anim/spin";                 // optional
+@import "groundworkcss/groundwork/anim/swing";                // optional
+@import "groundworkcss/groundwork/anim/tada";                 // optional
+@import "groundworkcss/groundwork/anim/wiggle";               // optional
+@import "groundworkcss/groundwork/anim/wobble";               // optional
+
+@import "groundworkcss/groundwork/responsive/all-responsive"; // recommended
 ```
 
 **in application.js**
 
 ```javascript
+//= require "groundworkcss/jquery-placeholderText"
+//= require "groundworkcss/jquery-responsiveTables"
 //= require "groundworkcss/jquery-responsiveText"
-//= require "groundworkcss/jquery.cycle2"
-//= require "groundworkcss/jquery.magnific-popup"
+//= require "groundworkcss/jquery-truncateLines"
+//= require "groundworkcss/checklists"
+//= require "groundworkcss/dismissible"
+//= require "groundworkcss/equalizeColumns"
+//= require "groundworkcss/forms"
+//= require "groundworkcss/menus"
+//= require "groundworkcss/navigation"
+//= require "groundworkcss/tabs"
 ```
 
 ### Setup your layout with the GroundworkCSS boilerplate
@@ -85,31 +151,7 @@ Add the following to the `<head>` section in your layout file (i.e. `app/views/l
   <!--[if IE]>
   <link type="text/css" rel="stylesheet" href="/assets/groundworkcss/groundwork-ie.css">
   <![endif]-->
-  <!--[if IE 7]>
-  <link type="text/css" rel="stylesheet" href="/assets/groundworkcss/font-awesome-ie7.min.css">
-  <![endif]-->
   <%= javascript_include_tag("application") %>
-  <script type="text/javascript">
-    // SVG support?
-    Modernizr.load({
-      test: Modernizr.inlinesvg,
-      yep: [
-        "/assets/groundworkcss/social-icons-svg.css"
-      ],
-      nope: [
-        "/assets/groundworkcss/social-icons-png.css",
-        "/assets/sidereel-ie/svg-to-png.js"
-      ]
-    });
-    // HTML5 placeholder support?
-    Modernizr.load({
-      test: Modernizr.input.placeholder,
-      nope: [
-        '/assets/groundworkcss/placeholder_polyfill.css',
-        '/assets/groundworkcss/libs/placeholder_polyfill.jquery.js'
-      ]
-    });
-  </script>
 ```