Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cldwalker committed Jan 11, 2011
1 parent a934c0d commit 16483bf
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.rdoc
Expand Up @@ -8,17 +8,29 @@ easy to build custom shells (i.e. for a gem or application) and complex shells (

== Install

Install the gem with:
If you have {readline}[http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html], install ripl with:

sudo gem install ripl
gem install ripl

To make your first ripl experience smoother, also install these plugins:
If you don't have readline, first install ripl with {a pure ruby
readline}[https://github.com/luislavena/rb-readline]:

gem install ripl rb-readline -- --without-readline

Then, add the following to ~/.riplrc:

Ripl.config[:readline] = 'rb-readline'
Ripl.config[:completion] = {:readline => :ruby }

== Setup

To make your first ripl experience smoother, install these plugins:

# Adds multi-line evaluation
sudo gem install ripl-multi_line
gem install ripl-multi_line

# Ignore errors caused by irb-specific configuration in ~/.irbrc
sudo gem install ripl-irb
gem install ripl-irb

# Add to ~/.riplrc
require 'ripl/multi_line'
Expand Down Expand Up @@ -161,6 +173,8 @@ see {ripl-rails}[http://github.com/cldwalker/ripl-rails].
* {ripl-profiles}[https://github.com/janlelis/ripl-profiles]: load ripl profiles with a --profile option
* {ripl-short_errors}[https://github.com/janlelis/ripl-misc/blob/master/lib/ripl/short_errors.rb]:
display short backtrace
* {ripl-rocket}[https://github.com/janlelis/ripl-rocket]: outputs ripl result as a hash rocket
* {ripl-padrino}[https://github.com/achiu/ripl-padrino]: console for padrino

== Ripl Shells
Shells built on top of ripl:
Expand Down

0 comments on commit 16483bf

Please sign in to comment.