From c361229ef0d27238dca34e6de6f43af2d11ed0f2 Mon Sep 17 00:00:00 2001 From: Chris Eppstein Date: Sun, 9 May 2010 23:17:49 -0700 Subject: [PATCH] [Docs] Better intro page. --- doc-src/content/index.haml | 59 +++++++++++++++++++++++++-------- doc-src/content/screencast.haml | 13 ++++++++ 2 files changed, 59 insertions(+), 13 deletions(-) create mode 100644 doc-src/content/screencast.haml diff --git a/doc-src/content/index.haml b/doc-src/content/index.haml index 0fc5471a..7e471707 100644 --- a/doc-src/content/index.haml +++ b/doc-src/content/index.haml @@ -6,24 +6,57 @@ body_id: home %article %h1#logo Compass - %p + :markdown Compass is a stylesheet authoring tool that uses the Sass stylesheet language to make your stylesheets smaller and your web site easier to maintain. Compass provides ports of the best of breed css frameworks that you can use without forcing you to use their presentational class names. It’s a new way of thinking about stylesheets that must be seen in action! - - %h2 Screencast Tutorial - - %p - This screencast will walk you through getting set up, - learning Sass, and then how to use Compass to style a webpage. - - - - %h2 Bugs Reports, Discussions, Support - - :markdown + + ## Installing + + Compass is a tool that runs on the command line. + + On any system with ruby installed, open your terminal and type: + + gem install compass + + This will install Compass and Sass too. Verify that compass is installed: + + compass version + + ## Creating a stand-alone project + + compass create myproject + mate myproject + compass watch myproject + + If you don't have TextMate, substitute the `mate myproject` part with the text + editor of your choice. Edit the `*.scss` files in the `src` directory. + These files are yours and you can change them as you see fit, delete them, + make new ones, etc. Compass will automatically compile them into css in the + `stylesheets` directory whenever they change. + + ## Rails Support + + compass init rails /path/to/myrailsproject + + ## Installing a framework + + When creating a new project: + + compass create myproject --using blueprint/basic + + When installing into an existing project: + + compass install myproject --using blueprint/semantic + + With Rails: + + compass init rails /path/to/myrailsproject --using blueprint/semantic + + ## Bugs Reports, Discussions, Support + Send a note to the [mailing list](http://groups.google.com/group/compass-users) and/or [File a bug](http://github.com/chriseppstein/compass/issues). \ No newline at end of file diff --git a/doc-src/content/screencast.haml b/doc-src/content/screencast.haml new file mode 100644 index 00000000..bd47e669 --- /dev/null +++ b/doc-src/content/screencast.haml @@ -0,0 +1,13 @@ +--- +title: Compass Documentation +crumb: Docs +body_id: home +--- +%h1 Screencast Tutorial + +%p + This screencast will walk you through getting set up, + learning Sass, and then how to use Compass to style a webpage. + + +