rhodes 2.2.6 → 2.3.0.beta.1

data/doc/install.txt

@@ -0,0 +1,35 @@
+# Install Rhodes
+
+## Instant Rhodes (Windows)
+The easiest way to install Rhodes on Windows is to use the [Instant Rhodes installer](http://rhomobile.com/instant-rhodes).  This will install Ruby, Rubygems, Redis, Rhodes and Rhosync gems and dependencies.
+
+Once the installer has completed, you can skip to the [Setup Rhodes section](#setup-rhodes).
+
+## Rhodes Gem
+To install the Rhodes gem, you will need the following tools installed:
+
+* [Ruby](http://www.ruby-lang.org/en/) (On Windows, [RubyInstaller](http://rubyinstaller.org) is a convenient way to install Ruby)
+* [RubyGems](http://docs.rubygems.org/) (RubyGems offers a .tgz, a .zip, and a .gem download. You want the .zip.)
+
+NOTE: Windows doesn't come with the necessary build tools to install gems ('make', for example). There are various ways to get these tools, but the [GnuWin32](http://gnuwin32.sourceforge.net/) project provides the tools, and can be conveniently installed via the [GetGnuWin32](http://sourceforge.net/projects/getgnuwin32/files/) installer.
+
+The first step in using Rhodes is to install the Rhodes gem (you may want to put "sudo" in the front of this command on OS X):
+
+    :::term
+    $ gem install rhodes
+
+
+NOTE: If you get any "`no such file to load -- something`" messages while running the rake tasks or rhodes commands, this can usually be resolved by running '[sudo] gem install something'.
+
+## Setup Rhodes
+
+Once you have Rhodes, you will need the SDKs for the platform you want to build your app on. These instructions are found [here](build).
+
+After you install the gem and your desired SDKs, you need to run:
+
+	:::term
+	$ rhodes-setup
+
+This will prompt you for where you installed the SDKs for the various platforms.  The installation script will display its best guess as to where the SDK is. You can then enter a new location, or leave it blank to use the suggestion. If you are not building for a specific platform (for example, you can't build for the iPhone on Windows), you can leave that SDK location blank. You can find prerequisites for each platform [here](build#all-platforms-prerequisites).
+
+

data/doc/introduction.txt

@@ -0,0 +1,88 @@
+# Rhodes 
+
+## Introduction
+
+Rhodes is a framework for building locally executing, device-optimized mobile applications. These applications are optimized for interacting with transactional enterprise application backends. It is also designed to work with synced local data using a local database such as SQLite or HSQLDB and a generic backend synchronization framework such as [RhoSync](../rhosync) (another open source component available from [Rhomobile](http://rhomobile.com)). Rhodes is available for iPhone, Research in Motion (Blackberry), Windows Mobile, and Android phones.
+
+The [Tutorial](tutorial) describes how to install Rhodes and start on building your apps. The rest of this Developer Reference covers all Rhodes features.
+
+## Supported Operating Systems
+### BlackBerry
+BlackBerry 4.6, 4.7, 5.0, 6.0
+
+NOTE: 4.2 and 4.5 are supported but database access is very slow on this devices.
+
+### Windows Mobile
+Windows Mobile 6.1 Professional, 6.0 Standard
+
+### Android
+Android 1.6 and greater
+
+### iPhone
+All versions of iPhone 3.0 or greater, iPad
+
+## Rhodes Application
+
+Rhodes Application is a web application running locally on the device. It is implement standard MVC architecture:
+
+* Views are set of ERB templates, HTML, CSS, and JavaScript files executed by the WebView control available on the device and served by the local web server. That server is very lightweight web server running on the device. See [User Interface](ui) section for more details on [Layouts](ui#view-layouts), [CSS framework](ui#css-framework), [JavaScrip frameworks](ui#javascript-frameworks), [Menus](ui#menu), and [Native UI elements](ui#native-toolbar-control) you may use in the View.  
+* Controllers are set of usually very simple Ruby scripts in controller.rb files. You have access to many [native device capabilities](device-caps) from your controllers.
+* Models are defined by a Ruby script in model.rb file.
+
+See Rhodes [App Structure](application) topic for more details.
+
+You may generate Rhodes Application using [rhodes](generator) utility. 
+
+## Contributing
+Want to add features to Rhodes? Found a bug that you want report or fix?
+
+### Report Rhodes Issues
+Please report bugs/features/enhancements to the [google group](http://groups.google.com/group/rhomobile).
+
+### Run Rhodes Specs
+First run the rhodes specs to make sure your environment is up-to-date for development (currently the specs only run on OSX):
+
+[Fork](http://help.github.com/forking/)  the [Rhodes repository](http://github.com/rhomobile/rhodes).
+
+Clone your new repo: 
+	:::term
+	$ git clone git://github.com/<yourhandle>/rhodes.git
+	$ cd rhodes
+	$ bin/rhodes-setup
+
+Run Rhodes framework_spec and phone_spec targets
+	:::term
+	$ rake run:allspecs 
+
+
+If everything passes (pending specs are OK), then your environment is ready for development. If you have trouble installing a particular gem or the specs just won't run properly, please feel free to ping the [rhomobile google group](mailto:rhomobile@googlegroups.com) or [hop on IRC](http://webchat.freenode.net/?channels=rhomobile) to chat with other Rhodes developers.
+
+### Contributing your Patch
+Now that you're environment is ready, make your changes!
+
+Create a topic branch:
+	:::term
+	$ git checkout -b cool_new_feature
+	
+Write tests, [for example](http://github.com/rhomobile/rhodes/blob/a905e9c9781bfe6e5003e8c8a11cd5418b08df73/spec/framework_spec/app/spec/rhom_object_spec.rb#L239).
+
+Make changes...
+
+Add relevant documentation (RDoc, update the README if relevant)
+
+Push to your branch:
+	:::term
+	$ git push origin cool_new_feature
+
+Send a note to the [google group](http://groups.google.com/group/rhomobile)
+
+That's it! We recommend following [these ruby style guidelines](http://github.com/chneukirchen/styleguide/blob/master/RUBY-STYLE) when coding.
+
+If you are interested us using your patch to Rhodes you will need to submit a [contribution agreement](http://rhomobile.com/community/contributing/) to us.
+
+## Framework Architecture
+
+<img src='/images/rhodes-framework.png'/>
+
+
+