[macruby-changes] [4680] DietRB/trunk/README.rdoc

source_changes at macosforge.org source_changes at macosforge.org
Fri Oct 8 03:58:43 PDT 2010


Revision: 4680
          http://trac.macosforge.org/projects/ruby/changeset/4680
Author:   eloy.de.enige at gmail.com
Date:     2010-10-08 03:58:42 -0700 (Fri, 08 Oct 2010)
Log Message:
-----------
Add docs to README about the extensions, such as the new history and colorize ones.

From: Eloy Duran <eloy.de.enige at gmail.com>

Modified Paths:
--------------
    DietRB/trunk/README.rdoc

Modified: DietRB/trunk/README.rdoc
===================================================================
--- DietRB/trunk/README.rdoc	2010-10-08 10:58:36 UTC (rev 4679)
+++ DietRB/trunk/README.rdoc	2010-10-08 10:58:42 UTC (rev 4680)
@@ -11,33 +11,39 @@
 and investigate what else people really really need. After that it's time to
 polish.
 
-== IRB Extensions people use:
+== Extensions
 
-* cypher: irb_rocket, utility_belt, hirb, and awesome_print.
-  I also occasionally use sketches, but I wouldn't really miss it if I didn't have it.
+* irb/ext/colorize.rb, adds support for colorizing the prompt and result. The
+  code was based upon Wirble's implementation, so your custom Wirble themes
+  should still work.
+  
+  Configure it with:
+  
+  * IRB.formatter.color_scheme = scheme, where scheme can be: :dark_background,
+    :light_background, or :fresh. Defaults to :dark_background.
+  
+  * IRB.formatter.colors returns the hash of current token-type to color
+    mappings.
 
-* iain_nl: Wirble, AwesomePrint, Hirb. My irbrc: http://gist.github.com/368237
+* irb/ext/completion.rb, adds, as the name implies, autocompletion for
+  constants, variables, methods, etc.
 
-* svoop: Looksee, Wirble, Hirb and copy&paste support.
+* irb/ext/history.rb, stores/loads the history in and from the history file,
+  which is located at ~/.irb_history.
+  
+  It provides the following API:
+  
+  * Kernel#history(N), or Kernel#h, will show N number of the most recent history
+    entries. Defaults to 50.
+  
+  * Kernel#history!(entry_or_range), or Kernel#h!, will execute the specified
+    history entry, or entries if a range is given.
+  
+  * Kernel#clear_history! will clear the history and the history file.
 
-* irbaddict: is use Ben Bleything's irb history hack see lighting talks rubyconf 2006
+* irb/ext/macruby.rb, adds support for Cocoa development by starting an
+  NSRunloop. Loaded by default on MacRuby.
 
-* logankoester: You can find my irbrc over at github if you want to take a look. (http://github.com/logankoester/irbrc)
-  I've modified my IRB quite extensively: 
-  map_by_method 
-  what_methods 
-  prettyprint (pp) 
-  awesome_print 
-  net-http-spy 
-  the usual simple prompt, tab completion, auto indent 
-  wirble 
-  "clear" method to clear the screen 
-  fast load/reload shortcuts 
-  sketches 
-
-* trans: Wirble and of course irb/completion and history.
-  I try not to get too crazy about it b/c the more extensions you have the less you have a true Ruby slate to work with. Hmm.. which makes me think a command-line option to turn off most of it would be cool. Perhaps even two or three levels.
-
 == Differences
 
 * This IRB version specifically targets MacRuby, for now, and allows Cocoa
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macruby-changes/attachments/20101008/03cbc3a7/attachment-0001.html>


More information about the macruby-changes mailing list