Permalink
Browse files

Quick readme update

  • Loading branch information...
sporkd committed Feb 27, 2012
1 parent 21ca6eb commit 131b6ecc09a7ebd140f00414584d31573eee1f24
Showing with 31 additions and 5 deletions.
  1. +31 −5 README.md
View
@@ -9,7 +9,7 @@ by Paul Irish, Divya Manian and many other [fine folks](https://github.com/h5bp/
Installation
=========================
-In your Gemfile
+##### 1. In your Gemfile
```ruby
group :assets do
@@ -26,22 +26,48 @@ gem 'jquery-rails'
gem 'html5-rails'
```
-Install
+##### 2. Install your bundle
```
$ bundle install
```
-Run generator
+##### 3. Run the generator
```
$ rails generate html5:install
```
+##### (Here's what it does)
+
+ create config/compass.rb
+ create config/html5_rails.yml
+ create app/views/layouts/application.html.erb
+ create app/views/application
+ create app/views/application/_footer.html.erb
+ create app/views/application/_head.html.erb
+ create app/views/application/_header.html.erb
+ create app/views/application/_chromeframe.html.erb
+ insert app/assets/javascripts/application.js
+ gsub app/assets/javascripts/application.js
+ create app/assets/javascripts/polyfills.js
+ remove app/assets/stylesheets/application.css
+ create app/assets/stylesheets/_variables.css.scss
+ create app/assets/stylesheets/application.css.scss
+ create app/assets/stylesheets/application
+ create app/assets/stylesheets/application/chromeframe.css.scss
+ create app/assets/stylesheets/application/document.css.scss
+ create app/assets/stylesheets/application/media_queries.css.scss
+
+##### 4. And you're done!
+
+ rails server
+
+
Options
=========================
-To see other generators available:
+To see other generators available run:
```
$ rails generate html5:layout --help
@@ -56,7 +82,7 @@ Notes
[1] The `compass-h5bp` gem is not a runtime dependency, but it does need to be
included in your assets group for development and asset precompiling to work.
-[2] If you use `--template-engine=haml` (or `haml-rails`), the install
+[2] If you use `--template-engine=haml` (or `haml-rails` gem), the install
generator will remove your application.html.erb layout so that
application.html.haml will be used instead.

0 comments on commit 131b6ec

Please sign in to comment.