README.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 [![Travis Status](https://app.travis-ci.com/ruby/ruby.svg?branch=master)](https://app.travis-ci.com/ruby/ruby)
   6
   7 # What is Ruby?
   8
   9 Ruby is an interpreted object-oriented programming language often
  10 used for web development. It also offers many scripting features
  11 to process plain text and serialized files, or manage system tasks.
  12 It is simple, straightforward, and extensible.
  13
  14 ## Features of Ruby
  15
  16 * Simple Syntax
  17 * **Normal** Object-oriented Features (e.g. class, method calls)
  18 * **Advanced** Object-oriented Features (e.g. mix-in, singleton-method)
  19 * Operator Overloading
  20 * Exception Handling
  21 * Iterators and Closures
  22 * Garbage Collection
  23 * Dynamic Loading of Object Files (on some architectures)
  24 * Highly Portable (works on many Unix-like/POSIX compatible platforms as
  25   well as Windows, macOS, etc.) cf.
  26     https://docs.ruby-lang.org/en/master/maintainers_md.html#label-Platform+Maintainers
  27
  28 ## How to get Ruby
  29
  30 For a complete list of ways to install Ruby, including using third-party tools
  31 like rvm, see:
  32
  33 https://www.ruby-lang.org/en/downloads/
  34
  35 You can download release packages and the snapshot of the repository. If you want to
  36 download whole versions of Ruby, please visit https://www.ruby-lang.org/en/downloads/releases/.
  37
  38 ### Download with Git
  39
  40 The mirror of the Ruby source tree can be checked out with the following command:
  41
  42     $ git clone https://github.com/ruby/ruby.git
  43
  44 There are some other branches under development. Try the following command
  45 to see the list of branches:
  46
  47     $ git ls-remote https://github.com/ruby/ruby.git
  48
  49 You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source)
  50 if you are a committer.
  51
  52 ## How to build
  53
  54 See [Building Ruby](https://docs.ruby-lang.org/en/master/contributing/building_ruby_md.html)
  55
  56 ## Ruby home page
  57
  58 https://www.ruby-lang.org/
  59
  60 ## Documentation
  61
  62 - [English](https://docs.ruby-lang.org/en/master/index.html)
  63 - [Japanese](https://docs.ruby-lang.org/ja/master/index.html)
  64
  65 ## Mailing list
  66
  67 There is a mailing list to discuss Ruby. To subscribe to this list, please
  68 send the following phrase:
  69
  70     join
  71
  72 in the mail subject (not body) to the address [ruby-talk-request@ml.ruby-lang.org].
  73
  74 [ruby-talk-request@ml.ruby-lang.org]: mailto:ruby-talk-request@ml.ruby-lang.org?subject=join
  75
  76 ## Copying
  77
  78 See the file [COPYING](rdoc-ref:COPYING).
  79
  80 ## Feedback
  81
  82 Questions about the Ruby language can be asked on the [Ruby-Talk](https://www.ruby-lang.org/en/community/mailing-lists) mailing list
  83 or on websites like https://stackoverflow.com.
  84
  85 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.
  86
  87 ## Contributing
  88
  89 See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions.
  90
  91 ## The Author
  92
  93 Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.
  94
  95 <matz@ruby-lang.org>