Permalink
Browse files

readme: flag ```bash

  • Loading branch information...
1 parent 8936c9d commit 684f1105f6ac5df3e2dccdfecf36566828c78ad5 @jmettraux jmettraux committed Aug 3, 2012
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.mdown
View
@@ -17,7 +17,9 @@ ruote-kit uses [Bundler](http://gembundler.com/) to setup and maintain its
environment. Before running ruote-kit for the first time you need to install
Bundler (gem install bundler) and then run:
+```bash
$ bundle install
+```
Bundler will download all the required gems and install them for you.
@@ -29,21 +31,29 @@ Have a look at the Gemfile if you want to see the various dependencies.
* Get the source files using git
+```bash
$ git clone http://github.com/kennethkalmer/ruote-kit.git && cd ruote-kit
+```
* Make sure every dependency is resolved
+```bash
$ bundle install
+```
* Get going
+```bash
$ rackup
+```
### Using the RubyGem / Bundler
* You'll need an empty directory
+```bash
$ mkdir my-ruote-kit && cd my-ruote-kit
+```
* There are two files needed in that directory: Gemfile and config.ru
@@ -90,11 +100,15 @@ Have a look at the Gemfile if you want to see the various dependencies.
* Install all needed gems
+```bash
$ bundle install
+```
* Get going
+```bash
$ rackup
+```
### Accessing the web interface
@@ -131,33 +145,45 @@ ruote-kit ships with an application template for Ruby on Rails 3.
* install Rails
+```bash
$ gem install rails
+```
* create a new Rails app by running
+```bash
$ rails new foo -m https://github.com/kennethkalmer/ruote-kit/raw/master/rails-template.rb
+```
* cd into the new Rails dir
+```bash
$ cd foo
+```
* make sure all dependencies are met
+```bash
$ bundle install
+```
#### Update an existing Rails app to use ruote[-kit]
* in your Rails dir, apply the app template
+```bash
$ rake rails:template LOCATION=https://github.com/kennethkalmer/ruote-kit/raw/master/rails-template.rb
+```
#### Configure your ruote-kit integration
See config/initializers/ruote-kit.rb in your Rails app.
#### Run
+```bash
$ rails server
+```
Browse to <http://localhost:3000/_ruote> and you'll see there are no running processes. You could change that using the "Launch process" link ;-)

0 comments on commit 684f110

Please sign in to comment.