sass-site/README.md

35 lines
910 B
Markdown
Raw Normal View History

2013-10-12 23:46:16 +02:00
# Contributing
2013-10-12 23:46:16 +02:00
If you would like to contribute to the Sass website, please do the following:
2013-10-14 21:52:40 +02:00
* check out the [style guide](http://sass-lang.com/styleguide) for design &
code standards.
2013-10-12 23:46:16 +02:00
* write a detailed description of what you're adding in the pull request
(screenshots help).
* add any new UI elements to the style guide.
* submit the pull request.
* drink whisky.
2013-10-12 23:46:16 +02:00
Thanks!
2013-10-12 23:54:15 +02:00
2013-10-14 21:52:40 +02:00
— [Team Sass Design](http://twitter.com/teamsassdesign)
---
## Running Site Locally
2013-10-14 21:52:40 +02:00
This site is built with [middleman](http://middlemanapp.com), a Ruby framework
for building static sites.
2013-10-14 21:52:40 +02:00
You will need [Ruby](https://www.ruby-lang.org/en/downloads/),
[rubygems](http://rubygems.org/) and [bundler](http://bundler.io/) installed
before you can run the site locally.
If the above dependencies are installed, in your command line of preference,
navigate to the project repo and run:
```
bundle install
middleman
```