diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 179 |
1 files changed, 50 insertions, 129 deletions
@@ -1,27 +1,30 @@ -[](https://travis-ci.org/ruby/ruby) -[](https://ci.appveyor.com/project/ruby/ruby/branch/trunk) +[](https://github.com/ruby/ruby/actions?query=workflow%3A"MinGW") +[](https://github.com/ruby/ruby/actions?query=workflow%3A"Ubuntu") +[](https://github.com/ruby/ruby/actions?query=workflow%3A"Windows") +[](https://app.travis-ci.com/ruby/ruby) -# What's Ruby +[日本語](rdoc-ref:README.ja.md) -Ruby is the interpreted scripting language for quick and easy object-oriented -programming. It has many features to process text files and to do system -management tasks (as in Perl). It is simple, straight-forward, and -extensible. +# What is Ruby? -## Features of Ruby +Ruby is an interpreted object-oriented programming language often +used for web development. It also offers many scripting features +to process plain text and serialized files, or manage system tasks. +It is simple, straightforward, and extensible. -* Simple Syntax -* **Normal** Object-oriented Features (e.g. class, method calls) -* **Advanced** Object-oriented Features (e.g. Mix-in, Singleton-method) -* Operator Overloading -* Exception Handling -* Iterators and Closures -* Garbage Collection -* Dynamic Loading of Object Files (on some architectures) -* Highly Portable (works on many Unix-like/POSIX compatible platforms as - well as Windows, Mac OS X, Haiku, etc.) cf. - https://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms +## Features of Ruby +* Simple Syntax +* **Normal** Object-oriented Features (e.g. class, method calls) +* **Advanced** Object-oriented Features (e.g. mix-in, singleton-method) +* Operator Overloading +* Exception Handling +* Iterators and Closures +* Garbage Collection +* Dynamic Loading of Object Files (on some architectures) +* Highly Portable (works on many Unix-like/POSIX compatible platforms as + well as Windows, macOS, etc.) cf. + https://docs.ruby-lang.org/en/master/maintainers_md.html#label-Platform+Maintainers ## How to get Ruby @@ -30,146 +33,64 @@ like rvm, see: https://www.ruby-lang.org/en/downloads/ -The Ruby distribution files can be found on the following FTP site: - -ftp://ftp.ruby-lang.org/pub/ruby/ +You can download release packages and the snapshot of the repository. If you want to +download whole versions of Ruby, please visit https://www.ruby-lang.org/en/downloads/releases/. -The trunk of the Ruby source tree can be checked out with the following -command: +### Download with Git - $ svn co https://svn.ruby-lang.org/repos/ruby/trunk/ ruby +The mirror of the Ruby source tree can be checked out with the following command: -Or if you are using git then use the following command: + $ git clone https://github.com/ruby/ruby.git - $ git clone git://github.com/ruby/ruby.git - -There are some other branches under development. Try the following command +There are some other branches under development. Try the following command to see the list of branches: - $ svn ls https://svn.ruby-lang.org/repos/ruby/branches/ + $ git ls-remote https://github.com/ruby/ruby.git -Or if you are using git then use the following command: +You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) +if you are a committer. - $ git ls-remote git://github.com/ruby/ruby.git +## How to build -## Ruby home page +See [Building Ruby](https://docs.ruby-lang.org/en/master/contributing/building_ruby_md.html) -The URL of the Ruby home page is: +## Ruby home page https://www.ruby-lang.org/ -## Mailing list - -There is a mailing list to talk about Ruby. To subscribe to this list, please -send the following phrase: - - subscribe - -in the mail body (not subject) to the address -<mailto:ruby-talk-request@ruby-lang.org>. - -## How to compile and install - -This is what you need to do to compile and install Ruby: - -1. If you want to use Microsoft Visual C++ to compile ruby, read - [win32/README.win32](win32/README.win32) instead of this document. - -2. If `./configure` does not exist or is older than `configure.ac`, run - `autoconf` to (re)generate configure. - -3. 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. +## Documentation -4. Edit `defines.h` if you need. Usually this step will not be needed. +- [English](https://docs.ruby-lang.org/en/master/index.html) +- [Japanese](https://docs.ruby-lang.org/ja/master/index.html) -5. Remove comment mark(`#`) 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 do not allow dynamic loading), remove comment mark - from the line "`#option nodynamic`" in `ext/Setup`. - - Usually this step will not be needed. - -6. Run `make`. - - * On Mac, set RUBY\_CODESIGN environment variable with a signing identity. - It uses the identity to sign `ruby` binary. See also codesign(1). - -7. Optionally, run '`make check`' to check whether the compiled Ruby - interpreter works well. If you see the message "`check succeeded`", your - ruby works as it should (hopefully). - -8. Optionally, Run `make update-gems` and `make extract-gems` - - If you want to install bundled gems, run `make update-gems` and - `extract-gems` before run `make install`. - -9. Run '`make install`' - - This command will create the following directories and install files into - 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 Ruby's - program version +## Mailing list - You may have to be a super user to install ruby. +There is a mailing list to discuss Ruby. To subscribe to this list, please +send the following phrase: + join -If you fail to compile ruby, please send the detailed error report with the -error log and machine/OS type, to help others. +in the mail subject (not body) to the address [ruby-talk-request@ml.ruby-lang.org]. -Some extension libraries may not get compiled because of lack of necessary -external libraries and/or headers, then you will need to run '`make distclean-ext`' -to remove old configuration after installing them in such case. +[ruby-talk-request@ml.ruby-lang.org]: mailto:ruby-talk-request@ml.ruby-lang.org?subject=join ## Copying -See the file [COPYING](COPYING). +See the file [COPYING](rdoc-ref:COPYING). ## Feedback -Questions about the Ruby language can be asked on the Ruby-Talk mailing list -(https://www.ruby-lang.org/en/community/mailing-lists) or on websites like -(https://stackoverflow.com). +Questions about the Ruby language can be asked on the [Ruby-Talk](https://www.ruby-lang.org/en/community/mailing-lists) mailing list +or on websites like https://stackoverflow.com. -Bug reports should be filed at https://bugs.ruby-lang.org. Read [HowToReport] for more information. - -[HowToReport]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport +Bugs should be reported at https://bugs.ruby-lang.org. Read ["Reporting Issues"](https://docs.ruby-lang.org/en/master/contributing/reporting_issues_md.html) for more information. ## Contributing -See the file [CONTRIBUTING.md](CONTRIBUTING.md) - +See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing/contributing_md.html), which includes setup and build instructions. ## The Author -Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in -1995. +Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995. -<mailto:matz@ruby-lang.org> +<matz@ruby-lang.org> |