=begin

$Id: README.ja.rd,v 1.26 2003/10/08 05:25:47 yuya Exp $

= bRuby

* ((<1. 概要>))
* ((<2. 特徴>))
* ((<3. インストール>))
* ((<4. ドキュメント>))
* ((<5. 使用例>))
* ((<6. Exerbとの連携>))
* ((<7. ライセンス>))
* ((<8. 作者>))
* ((<9. Webサイト>))

== 1. 概要

bRubyは、オブジェクト指向プログラミング言語Rubyのインタプリタ内部で生成される
構造木を、ダンプ/アンダンプする拡張ライブラリです。

主に、Exerbと共に使用します。

== 2. 特徴

* プログラムの解読を少し難しくすることができます。
* ローディング速度が向上することがあります。
* ファイルサイズが小さくなることがあります。

== 3. インストール

bRubyはrubyのeval.c、parse.yへのパッチを必要とします。
bRubyをインストールする前にeval.c.patch、parse.y.patchを、それぞれ
eval.cとparse.yに当て、rubyを再コンパイルしてください。
（付属のパッチは、Ruby 1.8.0用です）

  $ patch eval.c eval.c.patch
  $ patch parse.y parse.y.patch

パッチ後、以下のコマンドを実行してください。

  $ ruby setup.rb config
  $ ruby setup.rb setup
  # ruby setup.rb install

== 4. ドキュメント

: ((<"ChangeLog.ja.rd"|URL:ChangeLog.ja.html>))
    変更履歴。

: ((<"doc/command.ja.rd"|URL:doc/command.ja.html>))
    コマンドリファレンス。

: ((<"doc/class.ja.rd"|URL:doc/class.ja.html>))
    クラスリファレンス。

== 5. 使用例

example/hello.rbをバイナリコードに変換し、実行します。

  $ cd example
  $ brbcmp.rb hello.rb
  $ brbexe.rb hello.brb

== 6. Exerbとの連携

Exerbは、オブジェクト指向プログラミング言語Rubyのスクリプト/拡張ライブラリを
単独で動作可能なWindows用実行形式ファイルに変換するソフトウェアです。

Exerbは、bRubyによって生成されたバイナリコードを読み込むことができます。
読み込んだバイナリコードは通常のRubyスクリプトと同じようにrequireすることが
できます。

レシピファイルでバイナリコードを定義するには、binaryディレクティブを使用します。

記述例：

  binary hello.brb

== 7. ライセンス

bRubyはLGPL(GNU Lesser General Public License)の条件下において配布されます。
LGPLの詳細は、doc/LGPLを参照してください。

== 8. 作者

Yuya Kato <yuya@katoden.co.jp>

== 9. Webサイト

((<URL:http://bruby.sourceforge.jp/>))

=end
