This is the official documentation for the SproutCore framework. You can see it live at the SproutCore Guides homepage.
This document contains a brief overview of how to contribute changes and additioins to the SproutCore Guides. For an in-depth explanation, see the Contributing Guide.
-
Fork the SproutCore Guides repository on GitHub.
-
Clone the fork on to your local machine.
$ git clone git://github.com/<yourname>/guides.git -
Add the main SproutCore Guides repository as a remote so you can fetch updates.
$ cd guides $ git remote add upstream git://github.com/sproutcore/guides.git
-
Normal gem install
$ gem install guides -
Install with Bundler
Alternatively you can use Bundler to install the guides gem. This has the benefit of ensuring that you are using the correct version of the guides gem.
$ gem install bundler $ cd guides $ bundle install
Before you make any changes, you'll want to pull in any upstream changes and create a new topic branch for your changes.
$ git pull upstream/master
$ git checkout -b <branchname>
Guides reside in the source directory and are written in a modified version of the [Textile](http://en.wikipedia.org/wiki/Textile_(markup_language) markup language. The best way to familiarize yourself with how to use Textile is to check out the other guides.
The guides gem makes it easy to see what the guides on your local machine will look like when they're published to guides.sproutcore.com. To preview your changes, do this from the guides directory:
$ guides preview
Now point a web browser to localhost:9292. This preview will keep itself updated as you make changes to the guides; all you have to do is refresh your browser window to see your latest changes.
You can get your changes and additions included by creating a pull request on GitHub using the topic branch you created above.
For more information on the SproutCore Guides, including a more in depth look at committing your additions and changes, see the contributing guide.
If you have any questions, the team can be reached at @sproutcore on Twitter, in the #sproutcore-dev IRC channel on Freenode, or at the SproutCore Google Group.