Permalink
Browse files

README normalization

  • Loading branch information...
1 parent 18b9c7c commit a6884a86bf52df935943cd011b7970babdc99018 @elia elia committed Oct 7, 2011
Showing with 39 additions and 19 deletions.
  1. +39 −19 README.md
View
@@ -1,29 +1,38 @@
-Web App Theme
-=============
+# Web App Theme
Web App Theme is a rails generator by [Andrea Franz](http://gravityblast.com) that you can use to generate admin panels quickly.
Inspired by cool themes like [Lighthouse](http://lighthouseapp.com/), [Basecamp](http://basecamphq.com/), [RadiantCMS](http://radiantcms.org/) and others,
it wants to be an idea to start developing a complete web application layout.
-Installation
-------------
+![Web App Theme screenshot](http://img.skitch.com/20091109-c2k618qerx1ysw5ytxsighuf3f.jpg)
+
+
+
-####Rails >= 3.1.0
+## Installation
+
+
+#### Rails >= 3.1.0
For this version, all the stylesheets are stored inside the gems assets path. They don't need to be copied to the to the application, unless you want to customize them (using the web_app_theme:assets generator). There only css file generated when you run the theme generator is the web_app_theme.css that includes the theme of your choice.
Add to your gemfile:
gem 'web-app-theme', '~> 0.8.0'
-####Other versions
+
+#### Other versions
You can use web-app-theme >= 0.6.2 with Rails 3. If you want to use it with rails 2, use web-app-theme 0.5.3
Specify the web-app-theme gem in your Gemfile, only for :development and :test
group :development, :test do
gem 'web-app-theme', '>= 0.6.2'
end
-Usage
------
+
+
+
+## Usage
+
+
### Theme Generator
@@ -56,6 +65,8 @@ If you need a layout for login and signup pages, you can use the `--type` option
rails g web_app_theme:theme sign --layout-type=sign
+
+
### Assets Generator
Used to copy a theme of your choice from the gem to your application, without parameters it will copy the 'default' theme
@@ -65,6 +76,8 @@ Used to copy a theme of your choice from the gem to your application, without pa
This will copy the theme files on your app/assets/stylesheets/web-app-theme path.
Also this will copy theme's images to app/assets/images/web-app-theme path
+
+
### Themed Generator
Start creating your controllers manually or with a scaffold, and then use the `themed generator` to overwrite the previously generated views.
@@ -123,33 +136,38 @@ If you want to have translated pages, simple create in your locale.yml the keys
all: All
-![Web App Theme screenshot](http://img.skitch.com/20091109-c2k618qerx1ysw5ytxsighuf3f.jpg)
-Contributing
----
+
+## Contributing
* Fork this repository.
* Duplicate the 'themes/default' folder and rename it.
* Modify the style.css file adding your favorite colors.
* Add a link to your theme in the 'Switch Theme' block inside the index.html file.
* Send a pull request.
-Links
------
+
+
+
+## Links
* Repository: git://github.com/pilu/web-app-theme.git
* List: <http://groups.google.com/group/web-app-theme-generator>
* Issues: <http://github.com/pilu/web-app-theme/issues>
* Gem: <http://gemcutter.org/gems/web-app-theme>
* Themes: <http://pilu.github.com/web-app-theme>
-Author
-------
+
+
+
+## Author
Andrea Franz - [http://gravityblast.com](http://gravityblast.com)
-Contributors
-------------
+
+
+
+## Contributors
* Nelson Fernandez
* Giovanni Intini
@@ -168,8 +186,10 @@ Contributors
* Sandro Duarte
* David Francisco
-Credits
--------
+
+
+
+## Credits
* Icons: FAMFAMFAM Silk icons <http://www.famfamfam.com/lab/icons/silk/>
* Buttons: Particletree - Rediscovering the Button Element <http://particletree.com/features/rediscovering-the-button-element/>

0 comments on commit a6884a8

Please sign in to comment.