Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add compiling instructions to the readme

  • Loading branch information...
commit 92764c4d118310624d8763aec965b4ee63621e91 1 parent 15869d2
@kaelig authored
Showing with 13 additions and 8 deletions.
  1. +13 −8 README.mkd
View
21 README.mkd
@@ -2,30 +2,35 @@
The Sass reference is the most complete documentation for Sass. It contains information on every language feature, all the options, and how to install it as a Rails plugin.
-You can currently read it at <http://www.kaelig.fr/bettersassdocs/> (will soon change).
+You can currently read it at <http://www.kaelig.fr/bettersassdocs/>.
This reference is readable on desktop, mobile and tablets.
-# Todo
+## Todo
- Move the reference to an other domain
-- Include [indented syntax](http://sass-lang.com/docs/yardoc/file.INDENTED_SYNTAX.html) examples
+- Include [indented syntax](http://sass-lang.com/docs/yardoc/file.INDENTED_SYNTAX.html) examples (maybe one day)
- Style all pages, especially the [Sass Functions](http://sass-lang.com/docs/yardoc/Sass/Script/Functions.html "Module: Sass::Script::Functions")
- Build script to auto-update the reference with fresh content every time the Sass gem is updated
- Rewrite some parts of the reference that may seem too technical for some developers
- Properties and functions search engine
-- Analytics
-# Authors
+## Authors
- [Hampton Catlin](http://hamptoncatlin.com)
- [Nathan Weizenbaum](http://nex-3.com)
- [Chris Eppstein](http://chriseppstein.github.com)
-# Design
+## Design” of Better Sass Docs
- [Kaelig](http://www.kaelig.fr)
-# Thanks
+## Thanks
-- [Paul Irish](https://github.com/paulirish)
+- [Paul Irish](https://github.com/paulirish)
+
+## Compiling the project
+
+Install Sass, then open the terminal and run:
+
+`sass --watch s.scss:s.css --compass`
Please sign in to comment.
Something went wrong with that request. Please try again.