README.ja.md

   1 [![Actions Status: MinGW](https://github.com/ruby/ruby/workflows/MinGW/badge.svg)](https://github.com/ruby/ruby/actions?query=workflow%3A"MinGW")
   2 [![Actions Status: RJIT](https://github.com/ruby/ruby/workflows/RJIT/badge.svg)](https://github.com/ruby/ruby/actions?query=workflow%3A"RJIT")
   3 [![Actions Status: Ubuntu](https://github.com/ruby/ruby/workflows/Ubuntu/badge.svg)](https://github.com/ruby/ruby/actions?query=workflow%3A"Ubuntu")
   4 [![Actions Status: Windows](https://github.com/ruby/ruby/workflows/Windows/badge.svg)](https://github.com/ruby/ruby/actions?query=workflow%3A"Windows")
   5 [![AppVeyor status](https://ci.appveyor.com/api/projects/status/0sy8rrxut4o0k960/branch/master?svg=true)](https://ci.appveyor.com/project/ruby/ruby/branch/master)
   6 [![Travis Status](https://app.travis-ci.com/ruby/ruby.svg?branch=master)](https://app.travis-ci.com/ruby/ruby)
   7 [![Cirrus Status](https://api.cirrus-ci.com/github/ruby/ruby.svg)](https://cirrus-ci.com/github/ruby/ruby/master)
   8
   9 # Rubyとは
  10
  11 Rubyはシンプルかつ強力なオブジェクト指向スクリプト言語です． Rubyは純粋なオブジェクト指向言語として設計されているので，
  12 オブジェクト指向プログラミングを手軽に行う事が出来ます．もちろん普通の手続き型のプログラミングも可能です．
  13
  14 Rubyはテキスト処理関係の能力などに優れ，Perlと同じくらい強力です．さらにシンプルな文法と，
  15 例外処理やイテレータなどの機構によって，より分かりやすいプログラミングが出来ます．
  16
  17 ## Rubyの特長
  18
  19 *   シンプルな文法
  20 *   普通のオブジェクト指向機能(クラス，メソッドコールなど)
  21 *   特殊なオブジェクト指向機能(Mixin，特異メソッドなど)
  22 *   演算子オーバーロード
  23 *   例外処理機能
  24 *   イテレータとクロージャ
  25 *   ガーベージコレクタ
  26 *   ダイナミックローディング (アーキテクチャによる)
  27 *   移植性が高い．多くのUnix-like/POSIX互換プラットフォーム上で動くだけでなく，Windows， macOS，
  28     Haikuなどの上でも動く cf.
  29     https://docs.ruby-lang.org/en/master/maintainers_md.html#label-Platform+Maintainers
  30
  31
  32 ## 入手法
  33
  34 サードパーティーツールを使った方法を含むRubyのインストール方法の一覧は
  35
  36 https://www.ruby-lang.org/ja/downloads/
  37
  38 を参照してください．
  39
  40 ### Git
  41
  42 ミラーをGitHubに公開しています． 以下のコマンドでリポジトリを取得できます．
  43
  44     $ git clone https://github.com/ruby/ruby.git
  45
  46 他のブランチの一覧は次のコマンドで見られます．
  47
  48     $ git ls-remote https://github.com/ruby/ruby.git
  49
  50 Rubyリポジトリの本来のmasterは https://git.ruby-lang.org/ruby.git にあります．
  51 コミッタはこちらを使います．
  52
  53 ## ホームページ
  54
  55 RubyのホームページのURLは
  56
  57 https://www.ruby-lang.org/
  58
  59 です．
  60
  61 ## メーリングリスト
  62
  63 Rubyのメーリングリストがあります．参加希望の方は [ruby-list-request@ml.ruby-lang.org] まで件名に
  64
  65     join
  66
  67 と書いて送って下さい．
  68
  69 Ruby開発者向けメーリングリストもあります．こちらではrubyのバグ，将来の仕様拡張など実装上の問題について議論されています．
  70 参加希望の方は [ruby-dev-request@ml.ruby-lang.org] までruby-listと同様の方法でメールしてください．
  71
  72 Ruby拡張モジュールについて話し合うruby-extメーリングリストと数学関係の話題について話し合うruby-mathメーリングリストと
  73 英語でrubyについて話し合うruby-talkメーリングリストもあります．参加方法はどれも同じです．
  74
  75 [ruby-list-request@ml.ruby-lang.org]: mailto:ruby-list-request@ml.ruby-lang.org?subject=join
  76 [ruby-dev-request@ml.ruby-lang.org]: mailto:ruby-dev-request@ml.ruby-lang.org?subject=join
  77
  78 ## コンパイル・インストール
  79
  80 以下の手順で行ってください．
  81
  82 1.  (Gitリポジトリから取得したソースをビルドする場合) `./autogen.sh` を実行して新しく `configure` を生成する
  83
  84 2.  `configure` を実行して `Makefile` などを生成する
  85
  86     環境によってはデフォルトのCコンパイラ用オプションが付きます． `configure` オプションで `optflags=..`
  87     `warnflags=..` 等で上書きできます．
  88
  89 3.  (必要ならば)`include/ruby/defines.h` を編集する
  90
  91     多分，必要無いと思います．
  92
  93 4.  (必要ならば)`ext/Setup` に静的にリンクする拡張モジュールを指定する
  94
  95     `ext/Setup` に記述したモジュールは静的にリンクされます．
  96
  97     ダイナミックローディングをサポートしていないアーキテクチャでは `Setup` の1行目の「`option nodynamic`」という行のコ
  98     メントを外す必要があります．
  99     また，このアーキテクチャで拡張モジュールを利用するためには，あらかじめ静的にリンクをしておく必要があります．
 100
 101 5.  `make` を実行してコンパイルする
 102
 103 6.  `make check`でテストを行う．
 104
 105     「`check succeeded`」と表示されれば成功です．ただしテストに成功しても完璧だと保証されている訳ではありません．
 106
 107 7.  `make install`
 108
 109     以下のディレクトリを作って，そこにファイルをインストー ルします．
 110
 111     *   `${DESTDIR}${prefix}/bin`
 112     *   `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}`
 113     *   `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 114     *   `${DESTDIR}${prefix}/lib`
 115     *   `${DESTDIR}${prefix}/lib/ruby`
 116     *   `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}`
 117     *   `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 118     *   `${DESTDIR}${prefix}/lib/ruby/site_ruby`
 119     *   `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}`
 120     *   `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 121     *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby`
 122     *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}`
 123     *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 124     *   `${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}`
 125     *   `${DESTDIR}${prefix}/share/man/man1`
 126     *   `${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system`
 127
 128
 129     RubyのAPIバージョンが'*x.y.z*'であれば，`${MAJOR}`は
 130     '*x*'で，`${MINOR}`は'*y*'，`${TEENY}`は'*z*'です．
 131
 132     **注意**: APIバージョンの `teeny` は，Rubyプログラムのバージョンとは異なることがあります．
 133
 134     `root` で作業する必要があるかもしれません．
 135
 136
 137 もし，コンパイル時にエラーが発生した場合にはエラーのログとマシン，OSの種類を含むできるだけ詳しいレポートを作者に送って下さると他の方のためにもなります．
 138
 139 ## 移植
 140
 141 UNIXであれば `configure` がほとんどの差異を吸収してくれるはずですが，思わぬ見落としがあった場合(ある事が多い)，作者にその
 142 ことを報告すれば，解決できる可能性があります．
 143
 144 アーキテクチャにもっとも依存するのはGC部です．RubyのGCは対象
 145 のアーキテクチャが`setjmp()`または`getcontext()`によって全てのレジスタを `jmp_buf` や `ucontext_t`
 146 に格納することと， `jmp_buf` や `ucontext_t` とスタックが32bitアラインメントされていることを仮定
 147 しています．特に前者が成立しない場合の対応は非常に困難でしょう． 後者の解決は比較的簡単で， `gc.c` でスタックをマークしている
 148 部分にアラインメントのバイト数だけずらしてマークするコードを追加するだけで済みます．`defined(__mc68000__)`で括られてい
 149 る部分を参考にしてください．
 150
 151 レジスタウィンドウを持つCPUでは，レジスタウィンドウをスタックにフラッシュするアセンブラコードを追加する必要があるかもしれません．
 152
 153 ## 配布条件
 154
 155 [COPYING.ja](https://docs.ruby-lang.org/en/master/COPYING_ja.html) ファイルを参照してください．
 156
 157 ## フィードバック
 158
 159 Rubyに関する質問は [Ruby-Talk]（英語）や [Ruby-List]（日本語）や，
 160 [stackoverflow] などのWebサイトに投稿してください．
 161
 162 バグ報告は https://bugs.ruby-lang.org で受け付けています．
 163
 164 [Ruby-Talk]: https://www.ruby-lang.org/en/community/mailing-lists
 165 [Ruby-List]: https://www.ruby-lang.org/ja/community/mailing-lists
 166 [stackoverflow]: https://ja.stackoverflow.com/
 167
 168 ## 著者
 169
 170 Rubyのオリジナル版は，1995年にまつもとゆきひろ氏によって設計・開発されました．
 171
 172 <mailto:matz@ruby-lang.org>