Skip to content

Commit

Permalink
First pass at the user install guide.
Browse files Browse the repository at this point in the history
Testing done:
- Ran through each step in the guide on OS X 10.6 with RVM ruby 1.9.2p0

Also added a dummy getting_started .textile so I could test the "next step" link.
  • Loading branch information
Shawn Morel authored and wagenet committed Feb 5, 2011
1 parent 84dac15 commit 5cbf1fe
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
7 changes: 7 additions & 0 deletions guides.yml
Expand Up @@ -14,9 +14,16 @@ authors:
- name: Jason Zimdars
nick: jz
description: Jason Zimdars is an experienced creative director and web designer who has lead UI and UX design for numerous websites and web applications. You can see more of his design and writing at <a href="http://www.thinkcage.com/">Thinkcage.com</a> or follow him on <a href="http://twitter.com/JZ">Twitter</a>
Contributors:
- name: Shawn Morel
nick: shawnmorel
description: Shawn Morel is a software generalist with lots of experience building user interfaces in Cocoa, Flex, and bare-bones HTML.

index:
Start Here:
- title: Install
url: install
text: "In this guide we'll walk you through installing SproutCore."
- title: Getting Started
url: getting_started
text: "Jump start your SproutCore development by playing along as we build a fully functional Todo List application."
Expand Down
7 changes: 7 additions & 0 deletions source/getting_started.textile
@@ -0,0 +1,7 @@
h2. Getting Started

Here we'll step you through writing your first SproutCore app.

TODO: fill this in

endprologue.
43 changes: 43 additions & 0 deletions source/install.textile
@@ -0,0 +1,43 @@
h2. Install

This guide covers installing SproutCore. By referring to this guide you will be able to:

* Install a bundled version of SproutCore to build your desktop-class web app.

endprologue.


h3. Prerequisites

You should already have Ruby 1.9 or later running on your system. If you need help installing Ruby please refer to the "RVM setup instructions":http://rvm.beginrescueend.com/

h3. Installing

The easiest way to install the pre-released version of SproutCore 1.5 is as a Ruby Gem:

<shell>
$ gem install --pre sproutcore
</shell>

Alternatively, if you want to use the latest stable release simply install the Gem as follows:

<shell>
$ gem install sproutcore
</shell>

The rest of these guides refer to SproutCore 1.5

h3. Testing your Install

To make sure that your system is configured correctly enter the following command:
<shell>
$ sproutcore help
</shell>

h3. Next Steps

Great, you're good to go. You'll probably want to continue with the "Getting Started":getting_started.html guide.

h3. Changelog

* February 1, 2011: first pass at the user install docs by "Shawn Morel":credits.html#shawnmorel

0 comments on commit 5cbf1fe

Please sign in to comment.