# HG changeset patch
# User Marcel Hlopko <marcel.hlopko@gmail.com>
# Date 1393590133 -3600
# Node ID 3ebfe9f36c3f6060c651307590d85f8696e43cab
# Parent  fdc2225c104b67bc5ee07905adaf4ec217c8b52b
improved README.rdoc

diff -r fdc2225c104b -r 3ebfe9f36c3f web/.ruby-version
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/.ruby-version	Fri Feb 28 13:22:13 2014 +0100
@@ -0,0 +1,1 @@
+ruby-2.1.1
diff -r fdc2225c104b -r 3ebfe9f36c3f web/Gemfile
--- a/web/Gemfile	Mon Nov 11 22:57:04 2013 +0000
+++ b/web/Gemfile	Fri Feb 28 13:22:13 2014 +0100
@@ -4,9 +4,8 @@
   gem "capistrano", "~> 2.15.4"
   gem "rvm-capistrano", "~> 1.3.1"
   gem "pry", "~> 0.9.12.2"
-  gem "pry-doc", "~> 0.4.6"
-  gem "pry-remote", "~> 0.1.7"
-  gem "pry-debugger", "~> 0.2.2"
+  gem 'byebug' # use when navigation in debugging needed (step, next, continue...)
+  gem 'pry-byebug'
   gem "rails-erd", "~> 1.1.0"
   gem "annotate", "~> 2.5.0"
 end
@@ -19,7 +18,7 @@
   gem "sdoc", "~> 0.3.20", {:require=>false}
 end
 
-gem "rails", "~> 4.0.0.rc2"
+gem "rails", "~> 4.0.0"
 gem "sqlite3", "~> 1.3.7"
 gem "jbuilder", "~> 1.0.2"
 gem "sass-rails", "~> 4.0.0.rc2"
diff -r fdc2225c104b -r 3ebfe9f36c3f web/Gemfile.lock
--- a/web/Gemfile.lock	Mon Nov 11 22:57:04 2013 +0000
+++ b/web/Gemfile.lock	Fri Feb 28 13:22:13 2014 +0100
@@ -45,6 +45,9 @@
     arel (4.0.0)
     atomic (1.1.13)
     builder (3.1.4)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
     capistrano (2.15.5)
       highline
       net-scp (>= 1.0.0)
@@ -62,12 +65,7 @@
     coffee-script-source (1.6.3)
     columnize (0.3.6)
     commonjs (0.2.6)
-    debugger (1.6.1)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.3)
     debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.3)
     diff-lcs (1.2.4)
     dotenv (0.8.0)
     dotenv-rails (0.8.0)
@@ -111,15 +109,9 @@
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pry-debugger (0.2.2)
-      debugger (~> 1.3)
-      pry (~> 0.9.10)
-    pry-doc (0.4.6)
-      pry (>= 0.9)
-      yard (>= 0.8)
-    pry-remote (0.1.7)
-      pry (~> 0.9)
-      slop (~> 3.0)
+    pry-byebug (1.3.2)
+      byebug (~> 2.7)
+      pry (~> 0.9.12)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -199,13 +191,13 @@
     uglifier (2.1.2)
       execjs (>= 0.3.0)
       multi_json (~> 1.0, >= 1.0.2)
-    yard (0.8.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   annotate (~> 2.5.0)
+  byebug
   capistrano (~> 2.15.4)
   dotenv-rails (~> 0.8.0)
   exception_notification!
@@ -214,10 +206,8 @@
   jquery-ui-rails (~> 4.0.3)
   less-rails (~> 2.3.3)
   pry (~> 0.9.12.2)
-  pry-debugger (~> 0.2.2)
-  pry-doc (~> 0.4.6)
-  pry-remote (~> 0.1.7)
-  rails (~> 4.0.0.rc2)
+  pry-byebug
+  rails (~> 4.0.0)
   rails-erd (~> 1.1.0)
   rickshaw_rails!
   rspec-rails (~> 2.13.2)
diff -r fdc2225c104b -r 3ebfe9f36c3f web/README.rdoc
--- a/web/README.rdoc	Mon Nov 11 22:57:04 2013 +0000
+++ b/web/README.rdoc	Fri Feb 28 13:22:13 2014 +0100
@@ -1,28 +1,46 @@
 == README
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+# Getting Started
+
+## Installing Ruby
 
-Things you may want to cover:
+Usually ruby installed with operating system is quite old (and slow), so we
+will install newer version. The process is not trivial so we will use
+existing tools - ruby-install (will checkout and compile ruby for us) and
+chruby (will allow us to switch between different versions of ruby).
 
-* Ruby version
-
-* System dependencies
+  wget -O ruby-install-0.4.0.tar.gz https://github.com/postmodern/ruby-install/archive/v0.4.0.tar.gz
+  tar -xzvf ruby-install-0.4.0.tar.gz
+  cd ruby-install-0.4.0/
+  sudo make install
 
-* Configuration
+  wget -O chruby-0.3.8.tar.gz https://github.com/postmodern/chruby/archive/v0.3.8.tar.gz
+  tar -xzvf chruby-0.3.8.tar.gz
+  cd chruby-0.3.8/
+  sudo make install
 
-* Database creation
+  echo "source /usr/local/share/chruby/chruby.sh" >> ~/.bashrc
+  echo "source /usr/local/share/chruby/auto.sh" >> ~/.bashrc
 
-* Database initialization
+  ruby-install ruby 2.1.1
+
+## Installing Rails (and other gems)
 
-* How to run the test suite
+Go to the root of calipel rails app (on my machine: /home/m/Projects/other/jv-calipel/web) and execute
 
-* Services (job queues, cache servers, search engines, etc.)
+  gem install bundler
+  bundle install
+
+## Preparing Databases
 
-* Deployment instructions
+In the web app root execute
 
-* ...
+  rake db:create:all
+  rake db:migrate
+  RAILS_ENV=test rake db:migrate
 
+## Starting Local Rails Server
 
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.
+In the web app root execute
+
+  rails server