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: MJIT](https://github.com/ruby/ruby/workflows/MJIT/badge.svg)](https://github.com/ruby/ruby/actions?query=workflow%3A"MJIT")
   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 # What's Ruby
  10
  11 Ruby is an interpreted object-oriented programming language often
  12 used for web development. It also offers many scripting features
  13 to process plain text and serialized files, or manage system tasks.
  14 It is simple, straightforward, and extensible.
  15
  16 ## Features of Ruby
  17
  18 *   Simple Syntax
  19 *   **Normal** Object-oriented Features (e.g. class, method calls)
  20 *   **Advanced** Object-oriented Features (e.g. mix-in, singleton-method)
  21 *   Operator Overloading
  22 *   Exception Handling
  23 *   Iterators and Closures
  24 *   Garbage Collection
  25 *   Dynamic Loading of Object Files (on some architectures)
  26 *   Highly Portable (works on many Unix-like/POSIX compatible platforms as
  27     well as Windows, macOS, etc.) cf.
  28     https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers
  29
  30
  31 ## How to get Ruby
  32
  33 For a complete list of ways to install Ruby, including using third-party tools
  34 like rvm, see:
  35
  36 https://www.ruby-lang.org/en/downloads/
  37
  38 ### 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 ### Subversion
  53
  54 Stable branches for older Ruby versions can be checked out with also the
  55 following command:
  56
  57     $ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby
  58
  59 Try the following command to see the list of branches:
  60
  61     $ svn ls https://svn.ruby-lang.org/repos/ruby/branches/
  62
  63
  64 ## Ruby home page
  65
  66 https://www.ruby-lang.org/
  67
  68 ## Mailing list
  69
  70 There is a mailing list to discuss Ruby. To subscribe to this list, please
  71 send the following phrase:
  72
  73     subscribe
  74
  75 in the mail body (not subject) to the address [ruby-talk-request@ruby-lang.org].
  76
  77 [ruby-talk-request@ruby-lang.org]: mailto:ruby-talk-request@ruby-lang.org?subject=Join%20Ruby%20Mailing%20List&body=subscribe
  78
  79 ## Requirements to build from repository
  80
  81 1. GNU or BSD make
  82 2. C99 compiler
  83 3. autoconf 2.67 or higher
  84 4. automake 1.15 or higher
  85 5. bison 2.3 or higher
  86 6. Ruby 2.2 or higher
  87
  88 When building from a released version, only a C99 compiler and GNU or BSD make
  89 is required.
  90
  91 ## How to compile and install
  92
  93 1.  If you want to use Microsoft Visual C++ to compile Ruby, read
  94     [win32/README.win32](rdoc-ref:win32/README.win32) instead of this document.
  95
  96 2.  Run `./autogen.sh` to generate configure, when you build the source checked
  97     out from the Git repository.
  98
  99 3.  Run `./configure`, which will generate `config.h` and `Makefile`.
 100
 101     Some C compiler flags may be added by default depending on your
 102     environment. Specify `optflags=..` and `warnflags=..` as necessary to
 103     override them.
 104
 105 4.  Edit `include/ruby/defines.h` if you need. Usually this step will not be needed.
 106
 107 5.  Optional: Remove comment mark(`#`) before the module names from `ext/Setup`.
 108
 109     This step is only necessary if you want to link modules statically.
 110
 111     If you don't want to compile dynamic extensions (probably on architectures
 112     which do not allow dynamic loading), remove comment mark from the line
 113     "`#option nodynamic`" in `ext/Setup`.
 114
 115     Usually this step will not be needed.
 116
 117 6.  Run `make`.
 118
 119     * On Mac, set RUBY\_CODESIGN environment variable with a signing identity.
 120       It uses the identity to sign `ruby` binary. See also codesign(1).
 121
 122 7.  Optionally, run '`make check`' to check whether the compiled Ruby
 123     interpreter works well. If you see the message "`check succeeded`", your
 124     Ruby works as it should (hopefully).
 125
 126 8.  Run '`make install`'.
 127
 128     This command will create the following directories and install files into
 129     them.
 130
 131     *   `${DESTDIR}${prefix}/bin`
 132     *   `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}`
 133     *   `${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 134     *   `${DESTDIR}${prefix}/lib`
 135     *   `${DESTDIR}${prefix}/lib/ruby`
 136     *   `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}`
 137     *   `${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 138     *   `${DESTDIR}${prefix}/lib/ruby/site_ruby`
 139     *   `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}`
 140     *   `${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 141     *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby`
 142     *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}`
 143     *   `${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}`
 144     *   `${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}`
 145     *   `${DESTDIR}${prefix}/share/man/man1`
 146     *   `${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system`
 147
 148
 149     If Ruby's API version is '*x.y.z*', the `${MAJOR}` is '*x*', the
 150     `${MINOR}` is '*y*', and the `${TEENY}` is '*z*'.
 151
 152     **NOTE**: teeny of the API version may be different from one of Ruby's
 153     program version
 154
 155     You may have to be a super user to install Ruby.
 156
 157 If you fail to compile Ruby, please send the detailed error report with the
 158 error log and machine/OS type, to help others.
 159
 160 Some extension libraries may not get compiled because of lack of necessary
 161 external libraries and/or headers, then you will need to run '`make distclean-ext`'
 162 to remove old configuration after installing them in such case.
 163
 164 ## Copying
 165
 166 See the file [COPYING](rdoc-ref:COPYING).
 167
 168 ## Feedback
 169
 170 Questions about the Ruby language can be asked on the [Ruby-Talk] mailing list
 171 or on websites like https://stackoverflow.com.
 172
 173 Bugs should be reported at https://bugs.ruby-lang.org. Read [HowToReport] for more information.
 174
 175 [Ruby-Talk]: https://www.ruby-lang.org/en/community/mailing-lists
 176 [HowToReport]: https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport
 177
 178 ## Contributing
 179
 180 See the file [CONTRIBUTING.md](rdoc-ref:CONTRIBUTING)
 181
 182 ## The Author
 183
 184 Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.
 185
 186 <matz@ruby-lang.org>