compass/README.markdown

56 lines
2.8 KiB
Markdown
Raw Normal View History

2008-08-23 23:52:44 +00:00
# Compass
2009-04-24 23:22:14 +00:00
A [Sass][sass]-based CSS Meta-Framework that allows you to mix and match any of the following CSS frameworks:
- [Compass Core][compass_core_website] - [Wiki Documentation][compass_core_wiki]
- [Blueprint][blueprint_website] - [Wiki Documentation][bleuprint_wiki]
- [960][ninesixty_website] - [Wiki Documentation][ninesixty_wiki]
2009-11-19 19:03:47 +00:00
- [Susy][susy_website] - [Wiki Documentation][susy_wiki]
- [YUI][yui_website] - [Wiki Documentation][yui_wiki]
2009-09-01 16:18:02 +00:00
- New frameworks and extensions are [tracked on the wiki][plugins_wiki] as they are created.
2009-06-21 10:32:40 +00:00
- Other frameworks can be added relatively easily. Create your own!
2008-08-23 23:52:44 +00:00
## Compass Provides
2009-06-21 10:32:40 +00:00
2009-04-24 23:22:14 +00:00
1. A [command line tool][command_line_wiki] for managing your Sass projects.
2. Simple integration with [Ruby-on-Rails][ruby_on_rails_wiki], [Merb][merb_wiki], [StaticMatic][static_matic_wiki], and even [non-ruby application servers][command_line_wiki].
2009-01-02 09:00:42 +00:00
3. Loads of Sass mixins to make building your website a snap.
2008-08-23 23:52:44 +00:00
2009-11-19 19:03:47 +00:00
## Quick Start
$ (sudo) gem install compass
$ compass create my_compass_project --using blueprint
$ cd my_compass_project
$ compass watch
2008-08-23 23:52:44 +00:00
## More Information
2009-04-24 23:22:14 +00:00
Please see the [wiki][wiki]
## Author
2009-06-21 10:32:40 +00:00
Compass is written by [Chris Eppstein][chris_eppstein].<br>
Chris is the Software Architect of [Caring.com][caring.com] and a member of the [Sass][sass] core team.
## License
Copyright (c) 2008-2009 Christopher M. Eppstein<br>
All Rights Reserved.<br>
Released under a [slightly modified MIT License][license].
2008-08-23 23:52:44 +00:00
2009-09-01 16:12:50 +00:00
[sass]: http://sass-lang.com/ "Syntactically Awesome StyleSheets"
2009-04-24 23:22:14 +00:00
[compass_core_website]: http://github.com/chriseppstein/compass/tree/master/frameworks/compass
[compass_core_wiki]: http://github.com/chriseppstein/compass/wikis/compass-core-documentation
[blueprint_website]: http://blueprintcss.org/
[bleuprint_wiki]: http://github.com/chriseppstein/compass/wikis/blueprint-documentation
[yui_website]: http://developer.yahoo.com/yui/grids/
[yui_wiki]: http://github.com/chriseppstein/compass/wikis/yui-documentation
2009-09-01 16:18:02 +00:00
[plugins_wiki]: http://github.com/chriseppstein/compass/wikis/compass-plugins
2009-04-24 23:22:14 +00:00
[ninesixty_website]: http://960.gs/
[ninesixty_wiki]: http://github.com/chriseppstein/compass/wikis/960gs-documentation
[command_line_wiki]: http://wiki.github.com/chriseppstein/compass/command-line-tool
[wiki]: http://github.com/chriseppstein/compass/wikis/home
[ruby_on_rails_wiki]: http://wiki.github.com/chriseppstein/compass/ruby-on-rails-integration
[merb_wiki]: http://wiki.github.com/chriseppstein/compass/merb-integration
[static_matic_wiki]: http://wiki.github.com/chriseppstein/compass/staticmatic-integration
2009-11-19 19:03:47 +00:00
[chris_eppstein]: http://chriseppstein.github.com
2009-04-24 23:22:14 +00:00
[caring.com]: http://www.caring.com/ "Senior Care Resources"
2009-06-21 10:32:40 +00:00
[license]: http://github.com/chriseppstein/compass/tree/master/LICENSE.markdown
2009-11-19 19:03:47 +00:00
[susy_website]: http://www.oddbird.net/susy/
[susy_wiki]: http://github.com/chriseppstein/compass/wikis/susy-documentation