Update README

This commit is contained in:
Chris Eppstein 2012-03-18 02:20:59 -07:00
parent b9c1497300
commit d63af50ab1

View File

@ -1,59 +1,29 @@
# Compass # Compass Stylesheet Authoring Framework
Build Status: ![Build Status](https://secure.travis-ci.org/chriseppstein/compass.png) Build Status: ![Build Status](https://secure.travis-ci.org/chriseppstein/compass.png)
A [Sass][sass]-based CSS Meta-Framework that allows you to mix and match any of the following CSS frameworks: ## Resources
- [Compass Core][compass_core_website] - [Wiki Documentation][compass_core_wiki] * [Compass Homepage](http://compass-style.org/)
- [Blueprint][blueprint_website] - [Wiki Documentation][bleuprint_wiki] * [Installing Compass](http://compass-style.org/install/)
- [960][ninesixty_website] - [Wiki Documentation][ninesixty_wiki] * [Compass Reference](http://compass-style.org/install/reference/)
- [Susy][susy_website] - [Wiki Documentation][susy_wiki]
- [YUI][yui_website] - [Wiki Documentation][yui_wiki]
- New frameworks and extensions are [tracked on the wiki][plugins_wiki] as they are created.
- Other frameworks can be added relatively easily. Create your own!
## Compass Provides
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][staticmatic], and even [non-ruby application servers][command_line_wiki].
3. Loads of Sass mixins to make building your website a snap.
## Quick Start
$ (sudo) gem install compass
$ compass create my_compass_project --using blueprint
$ cd my_compass_project
$ compass watch
## More Information
Please see the [wiki][wiki]
## Author ## Author
Compass is written by [Chris Eppstein][chris_eppstein].<br> 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. Chris is the Software Architect of [Caring.com][caring.com] and a member of the [Sass][sass] core team.
## Core Team Members
* [Scott Davis](https://github.com/scottdavis)
* [Eric Meyer](https://github.com/ericam)
* [Brandon Mathis](https://github.com/imathis)
* [Anthony Short](https://github.com/anthonyshort/)
## Major Contributors
* [Nico Hagenburger](https://github.com/hagenburger)
## License ## License
Copyright (c) 2008-2009 Christopher M. Eppstein<br> Copyright (c) 2008-2009 Christopher M. Eppstein<br>
All Rights Reserved.<br> All Rights Reserved.<br>
Released under a [slightly modified MIT License][license]. Released under a [slightly modified MIT License][license].
[sass]: http://sass-lang.com/ "Syntactically Awesome StyleSheets"
[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
[plugins_wiki]: http://github.com/chriseppstein/compass/wikis/compass-plugins
[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
[staticmatic]: https://github.com/mindeavor/staticmatic2
[chris_eppstein]: http://chriseppstein.github.com
[caring.com]: http://www.caring.com/ "Senior Care Resources"
[license]: http://github.com/chriseppstein/compass/tree/master/LICENSE.markdown
[susy_website]: http://www.oddbird.net/susy/
[susy_wiki]: http://github.com/chriseppstein/compass/wikis/susy-documentation