README.rdoc in ripl-0.3.0 vs README.rdoc in ripl-0.3.1
- old
+ new
@@ -6,21 +6,33 @@
easy to build custom shells (i.e. for a gem or application) and complex shells (i.e. for the
{web}[http://github.com/cldwalker/nirvana]). In other words, ripl is also a shell framework.
== 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'
require 'ripl/irb'
@@ -159,9 +171,11 @@
* {ripl-hijack}[http://github.com/cldwalker/ripl-hijack] : ripl console to a ruby process
* {ripl-misc}[http://github.com/cldwalker/ripl-misc] : a playground for ripl plugins
* {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:
* {nirvana}[http://github.com/cldwalker/nirvana]: A ruby web shell complete with autocomplete