From: Ilmari Heikkinen <kig@...>
Date: 2005-01-17T05:46:25+09:00
Subject: [ANN] IHelp 0.2.0

URL: http://fhtr.org/projects/ihelp/

Download:
=========

   Release: http://fhtr.org/projects/ihelp/releases/ihelp-0.2.0.tar.gz
   Darcs repo: http://dark.fhtr.org/repos/ihelp/


IHelp README
============

   The IHelp (Interactive Help) package provides contextual help for
   objects and methods by using ri.


Usage
-----

   Example:

     require 'ihelp'

     12.help
     "string".help :reverse # cute syntax - "string".help:reverse
     Array.help :map
     help "Array#map"

     # and, after generating ri docs for this (rdoc --ri ihelp/):
     IHelp.help


   To load IHelp automatically with irb, add the following to your 
.irbrc:
     require 'ihelp'

   If you think it makes the irb startup too slow, load it in a thread:
     Thread.new{ require 'ihelp' }

   But note that calling help will fail before it's completely loaded.


See also
--------

   ri --help
   rdoc --help
   ruby --help

   The ruby-doc.org Ruby documentation project: http://www.ruby-doc.org/
   Pickaxe book: http://www.ruby-doc.org/find/pickaxe
   Why's (Poignant) Guide to Ruby: http://poignantguide.net/ruby/


Requirements
------------

   * Ruby 1.8
   * generated ri documentation


Install
-------

   De-compress archive and enter its top directory.
   Then type:

    ($ su)
     # ruby setup.rb

   These simple step installs this program under the default
   location of Ruby libraries.  You can also install files into
   your favorite directory by supplying setup.rb some options.
   Try "ruby setup.rb --help".


License
-------

   Ruby's


Ilmari Heikkinen <kig misfiring net>