* README, README.ja: reformatted using rdoc markup. based on the

  patches by zzak (Zachary Scott) in [Feature #6388].
* README, README.ja: updated the author's mail address.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35518 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

3 files changed, 134 insertions, 125 deletions

diff --git a/ChangeLog b/ChangeLog
index 0ca6494f3c..25c0dc631d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+Wed May  2 13:06:37 2012  Nobuyoshi Nakada  <nobu@ruby-lang.org>
+
+	* README, README.ja: reformatted using rdoc markup.  based on the
+	  patches by zzak (Zachary Scott) in [Feature #6388].
+
+	* README, README.ja: updated the author's mail address.
+
 Wed May  2 09:46:09 2012  Kouji Takao  <kouji@takao7.net>
 
 	* ext/readline/readline.c (Readline.special_prefixes=)
diff --git a/README b/README
index d4296a9809..ccf24b04df 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-* What's Ruby
+= What's Ruby
 
 Ruby is the interpreted scripting language for quick and
 easy object-oriented programming.  It has many features to
@@ -6,26 +6,26 @@ process text files and to do system management tasks (as in
 Perl).  It is simple, straight-forward, and extensible.
 
 
-* Features of Ruby
+== Features of Ruby
 
-  + Simple Syntax
-  + *Normal* Object-Oriented features(ex. class, method calls)
-  + *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
-  + Operator Overloading
-  + Exception Handling
-  + Iterators and Closures
-  + Garbage Collection
-  + Dynamic Loading of Object files(on some architecture)
-  + Highly Portable (works on many Unix-like/POSIX compatible platforms
+*   Simple Syntax
+*   *Normal* Object-Oriented features(ex. class, method calls)
+*   *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
+*   Operator Overloading
+*   Exception Handling
+*   Iterators and Closures
+*   Garbage Collection
+*   Dynamic Loading of Object files(on some architecture)
+*   Highly Portable (works on many Unix-like/POSIX compatible platforms
     as well as Windows, Mac OS X, BeOS etc.)
     cf. http://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms
 
 
-* How to get Ruby
+== How to get Ruby
 
 The Ruby distribution files can be found in the following FTP site:
 
-  ftp://ftp.ruby-lang.org/pub/ruby/
+ftp://ftp.ruby-lang.org/pub/ruby/
 
 The trunk of the Ruby source tree can be checked out with the
 following command:
@@ -45,14 +45,14 @@ Or if you are using git then use following command:
 
   $ git ls-remote git://github.com/ruby/ruby.git
 
-* Ruby home-page
+== Ruby home-page
 
 The URL of the Ruby home-page is:
 
-   http://www.ruby-lang.org/
+http://www.ruby-lang.org/
 
 
-* Mailing list
+== Mailing list
 
 There is a mailing list to talk about Ruby.
 To subscribe this list, please send the following phrase
@@ -61,65 +61,65 @@ To subscribe this list, please send the following phrase
 e.g.
         subscribe Joseph Smith
 
-in the mail body (not subject) to the address <ruby-talk-ctl@ruby-lang.org>.
+in the mail body (not subject) to the address <mailto:ruby-talk-ctl@ruby-lang.org>.
 
 
-* How to compile and install
+== How to compile and install
 
 This is what you need to do to compile and install Ruby:
 
-  1. If ./configure does not exist or is older than configure.in,
+1.   If +./configure+ does not exist or is older than configure.in,
      run autoconf to (re)generate configure.
 
-  2. Run ./configure, which will generate config.h and Makefile.
+2.   Run +./configure+, which will generate config.h and Makefile.
 
      Some C compiler flags may be added by default depending on your
-     environment.  Specify optflags=.. and warnflags=.. as necessary
-     to override them.
+     environment.  Specify <tt>optflags=..</tt> and <tt>warnflags=..</tt> as
+     necessary to override them.
 
-  3. Edit defines.h if you need.  Usually this step will not be needed.
+3.   Edit +defines.h+ if you need. Usually this step will not be needed.
 
-  4. Remove comment mark(#) before the module names from ext/Setup (or
+4.   Remove comment mark(<tt>#</tt>) before the module names from +ext/Setup+ (or
      add module names if not present), if you want to link modules
      statically.
 
      If you don't want to compile non static extension modules
      (probably on architectures which does not allow dynamic loading),
-     remove comment mark from the line "#option nodynamic" in
-     ext/Setup.
+     remove comment mark from the line "<tt>#option nodynamic</tt>" in
+     +ext/Setup+.
 
-  5. Run make.
+5.   Run +make+.
 
-  6. Optionally, run 'make check' to check whether the compiled Ruby
-     interpreter works well.  If you see the message "check succeeded",
+6.   Optionally, run '<tt>make check</tt>' to check whether the compiled Ruby
+     interpreter works well. If you see the message "<tt>check succeeded</tt>",
      your ruby works as it should (hopefully).
 
-  7. Run 'make install'
+7.   Run '<tt>make install</tt>'
 
      This command will create following directories and install files
      onto them.
 
-       * ${DESTDIR}${prefix}/bin
-       * ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib
-       * ${DESTDIR}${prefix}/lib/ruby
-       * ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib/ruby/site_ruby
-       * ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
-       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/share/man/man1
-       * ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system
-
-     If Ruby's API version is `x.y.z', the ((|${MAJOR}|)) is `x', the
-     ((|${MINOR}|)) is `y', and the ((|${TEENY}|)) is `z'.
-
-     NOTE: teeny of the API version may be different from one of
+     * <tt>${DESTDIR}${prefix}/bin</tt>
+     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/share/man/man1</tt>
+     * <tt>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</tt>
+
+     If Ruby's API version is `_x.y.z_', the <tt>${MAJOR}</tt> is `_x_', the
+     <tt>${MINOR}</tt> is `_y_', and the <tt>${TEENY}</tt> is `_z_'.
+
+     *NOTE*: teeny of the API version may be different from one of
      Ruby's program version
 
      You may have to be a super user to install ruby.
@@ -128,20 +128,21 @@ If you fail to compile ruby, please send the detailed error report with
 the error log and machine/OS type, to help others.
 
 
-* Copying
+== Copying
 
-See the file COPYING.
+See the file +COPYING+.
 
 
-* The Author
+== The Author
 
 Feel free to send comments and bug reports to the author.  Here is the
 author's latest mail address:
 
-  matz@netlab.jp
+<mailto:matz@ruby-lang.org>
 
 -------------------------------------------------------
 created at: Thu Aug  3 11:57:36 JST 1995
+--
 Local variables:
-mode: indented-text
+mode: rdoc
 end:
diff --git a/README.ja b/README.ja
index 2702bf9aef..87f45d7dc9 100644
--- a/README.ja
+++ b/README.ja
@@ -1,4 +1,4 @@
-* Rubyとは
+= Rubyとは
 
 Rubyはシンプルかつ強力なオブジェクト指向スクリプト言語です．
 Rubyは最初から純粋なオブジェクト指向言語として設計されていま
@@ -10,29 +10,29 @@ Rubyはテキスト処理関係の能力などに優れ，Perlと同じくらい
 によって，より分かりやすいプログラミングが出来ます．
 
 
-* Rubyの特長
+== Rubyの特長
 
-  + シンプルな文法
-  + 普通のオブジェクト指向機能(クラス，メソッドコールなど)
-  + 特殊なオブジェクト指向機能(Mixin, 特異メソッドなど)
-  + 演算子オーバーロード
-  + 例外処理機能
-  + イテレータとクロージャ
-  + ガーベージコレクタ
-  + ダイナミックローディング (アーキテクチャによる)
-  + 移植性が高い．多くのUnix-like/POSIX互換プラットフォーム上で
+*   シンプルな文法
+*   普通のオブジェクト指向機能(クラス，メソッドコールなど)
+*   特殊なオブジェクト指向機能(Mixin, 特異メソッドなど)
+*   演算子オーバーロード
+*   例外処理機能
+*   イテレータとクロージャ
+*   ガーベージコレクタ
+*   ダイナミックローディング (アーキテクチャによる)
+*   移植性が高い．多くのUnix-like/POSIX互換プラットフォーム上で
     動くだけでなく，Windows， Mac OS X，BeOSなどの上でも動く
     cf. http://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatformsJa
 
-* 入手法
+== 入手法
 
-** FTPで
+=== FTPで
 
 以下の場所においてあります．
 
-  ftp://ftp.ruby-lang.org/pub/ruby/
+ftp://ftp.ruby-lang.org/pub/ruby/
 
-** Subversionで
+=== Subversionで
 
 開発先端のソースコードは次のコマンドで取得できます．
 
@@ -42,27 +42,27 @@ Rubyはテキスト処理関係の能力などに優れ，Perlと同じくらい
 
   $ svn ls http://svn.ruby-lang.org/repos/ruby/branches/
 
-** Gitで
+=== Gitで
 
 SubversionのミラーをGitHubに公開しています．
 以下のコマンドでリポジトリを取得できます．
 
   $ git clone git://github.com/ruby/ruby.git
 
-* ホームページ
+== ホームページ
 
 RubyのホームページのURLは
 
-   http://www.ruby-lang.org/
+http://www.ruby-lang.org/
 
 です．
 
 
-* メーリングリスト
+== メーリングリスト
 
 Rubyのメーリングリストがあります。参加希望の方は
 
-   ruby-list-ctl@ruby-lang.org
+mailto:ruby-list-ctl@ruby-lang.org
 
 まで本文に
 
@@ -74,7 +74,7 @@ Ruby開発者向けメーリングリストもあります。こちらではruby
 グ、将来の仕様拡張など実装上の問題について議論されています。
 参加希望の方は
 
-   ruby-dev-ctl@ruby-lang.org
+mailto:ruby-dev-ctl@ruby-lang.org
 
 までruby-listと同様の方法でメールしてください。
 
@@ -84,91 +84,91 @@ Ruby拡張モジュールについて話し合うruby-extメーリングリス�
 はどれも同じです。
 
 
-* コンパイル・インストール
+== コンパイル・インストール
 
 以下の手順で行ってください．
 
-  1. もしconfigureファイルが見つからない、もしくは
-     configure.inより古いようなら、autoconfを実行して
-     新しくconfigureを生成する
+1.   もし+configure+ファイルが見つからない、もしくは
+     +configure.in+より古いようなら、+autoconf+を実行して
+     新しく+configure+を生成する
 
-  2. configureを実行してMakefileなどを生成する
+2.   +configure+を実行して+Makefile+などを生成する
 
      環境によってはデフォルトのCコンパイラ用オプションが付き
-     ます．configureオプションで optflags=.. warnflags=.. 等
+     ます．+configure+オプションで <tt>optflags=..</tt> <tt>warnflags=..</tt> 等
      で上書きできます．
 
-  3. (必要ならば)defines.hを編集する
+3.   (必要ならば)+defines.h+を編集する
 
      多分，必要無いと思います．
 
-  4. (必要ならば)ext/Setupに静的にリンクする拡張モジュールを
+4.   (必要ならば)+ext/Setup+に静的にリンクする拡張モジュールを
      指定する
 
-     ext/Setupに記述したモジュールは静的にリンクされます．
+     +ext/Setup+に記述したモジュールは静的にリンクされます．
 
      ダイナミックローディングをサポートしていないアーキテク
-     チャではSetupの1行目の「option nodynamic」という行のコ
+     チャでは+Setup+の1行目の「<tt>option nodynamic</tt>」という行のコ
      メントを外す必要があります．また，このアーキテクチャで
      拡張モジュールを利用するためには，あらかじめ静的にリン
      クしておく必要があります．
 
-  5. makeを実行してコンパイルする
+5.   +make+を実行してコンパイルする
 
-  6. make checkでテストを行う．
+6.   <tt>make check</tt>でテストを行う．
 
-     「check succeeded」と表示されれば成功です．ただしテスト
+     「<tt>check succeeded</tt>」と表示されれば成功です．ただしテスト
      に成功しても完璧だと保証されている訳ではありません．
 
-  7. make install
+7.   <tt>make install</tt>
 
      以下のディレクトリを作って，そこにファイルをインストー
      ルします．
 
-       * ${DESTDIR}${prefix}/bin
-       * ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib
-       * ${DESTDIR}${prefix}/lib/ruby
-       * ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib/ruby/site_ruby
-       * ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby
-       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}
-       * ${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}
-       * ${DESTDIR}${prefix}/share/man/man1
-       * ${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system
-
-     RubyのAPIバージョンが`x.y.z'であれば，((|${MAJOR}|))は
-     `x'で，((|${MINOR}|))は`y'，((|${TEENY}|))は`z'です．
-
-     注意: APIバージョンのteenyは，Rubyプログラムのバージョ
+     * <tt>${DESTDIR}${prefix}/bin</tt>
+     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
+     * <tt>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</tt>
+     * <tt>${DESTDIR}${prefix}/share/man/man1</tt>
+     * <tt>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</tt>
+
+     RubyのAPIバージョンが`_x.y.z_'であれば，<tt>${MAJOR}</tt>は
+     `_x_'で，<tt>${MINOR}</tt>は`_y_'，<tt>${TEENY}</tt>は`_z_'です．
+
+     <b>注意</b>: APIバージョンの+teeny+は，Rubyプログラムのバージョ
      ンとは異なることがあります．
 
-     rootで作業する必要があるかもしれません．
+     +root+で作業する必要があるかもしれません．
 
 もし，コンパイル時にエラーが発生した場合にはエラーのログとマ
 シン，OSの種類を含むできるだけ詳しいレポートを作者に送ってく
 ださると他の方のためにもなります．
 
 
-* 移植
+== 移植
 
-UNIXであればconfigureがほとんどの差異を吸収してくれるはずで
+UNIXであれば+configure+がほとんどの差異を吸収してくれるはずで
 すが，思わぬ見落としがあった場合(あるに違いない)，作者にその
 ことをレポートすれば，解決できるかも知れません．
 
 アーキテクチャにもっとも依存するのはGC部です．RubyのGCは対象
-のアーキテクチャがsetjmp()またはgetcontext()によって全てのレ
-ジスタをjmp_bufやucontext_tに格納することと，jmp_bufや
-ucontext_tとスタックが32bitアラインメントされていることを仮定
+のアーキテクチャが<tt>setjmp()</tt>または<tt>getcontext()</tt>によって全てのレ
+ジスタを+jmp_buf+や+ucontext_t+に格納することと，+jmp_buf+や
++ucontext_t+とスタックが32bitアラインメントされていることを仮定
 しています．特に前者が成立しない場合の対応は非常に困難でしょ
-う．後者の解決は比較的簡単で，gc.cでスタックをマークしている
+う．後者の解決は比較的簡単で，+gc.c+でスタックをマークしている
 部分にアラインメントのバイト数だけずらしてマークするコードを
-追加するだけで済みます．「defined(__mc68000__)」で括られてい
+追加するだけで済みます．<tt>defined(\_\_mc68000\_\_)</tt>で括られてい
 る部分を参考にしてください．
 
 レジスタウィンドウを持つCPUでは，レジスタウィンドウをスタッ
@@ -176,16 +176,17 @@ ucontext_tとスタックが32bitアラインメントされていることを�
 れません．
 
 
-* 配布条件
+== 配布条件
 
-COPYING.jaファイルを参照してください。
++COPYING.ja+ファイルを参照してください。
 
 
-* 著者
+== 著者
 
-コメント，バグレポートその他は matz@netlab.jp まで．
+コメント，バグレポートその他は mailto:matz@ruby-lang.jp まで．
 -------------------------------------------------------
 created at: Thu Aug  3 11:57:36 JST 1995
+--
 Local variables:
-mode: indented-text
+mode: rdoc
 end: