Ruby Refactoring Browser

= What's this?
This software is a development tool working on Emacs that allow you to refactor
Ruby code.
This is alpha version and no documents are available.

= Requirements
Ruby 1.6.x + ruby_shim or Ruby 1.8.x.
Emacs 20.7 or later.

= Tested Emvironment
Emacs 21.3, Ruby 1.8.2 on Debian GNU/Linux.

= Installation / RRB core
Type these lines on command line to install core libraries:
  $ ruby setup.rb config
  $ ruby setup.rb setup
  # ruby setup.rb install

You can customize how RRB works with ~/.rrbrc (see doc/rrbrc.sample)

= Installation / Emacs interface
Copy elisp/rrb.el in load-path.

How to use: First, load rrb.el to Emacs.
Type M-x rrb-rename-local-variable(or rrb-rename-instance-variable, etc)
and input required information such as the name of variable.
Completion is available with [TAB] key.
And you can undo one refactoring to type M-x rrb-undo.

= Installation / Vim interface
You should install vim compiled with ruby scripting support.
Please copy vimscript/rrb.vim to ~/.vim/plugin/.

= Installation / FreeRIDE plugin
At first, finish the installation of RRB core.
Then, copy rubyide_tools_rrb/ to ${FreeRIDE}/plugins/.
So, the menu "Refactor" is added to the menubar of FreeRIDE, and you
can enjoy refactoring with it.

= Documentation
Sorry.
No English document is prepared yet.

= Copyright and License
Copyright (C) 2004  OHBAYASHI Ippei, YOSHIDA Yuichi, HARA Yutaka
Copyright (C) 2004  Kyoto univ. Microcomputer Club

Ruby Refactoring Browser is distributed under the same term as Ruby.

= Developers
OHBAYASHI Ippei
HARA Yutaka
YOSHIDA Yuichi

= Comments and bug reports
Please send comments and bug reports to OHBAYASHI(ohai@kmc.gr.jp).
