Skip to content
The Ruby Programming Language
Ruby C Emacs Lisp Tcl Objective-C Ragel in Ruby Host Other
Pull request Compare This branch is 11121 commits behind ruby:trunk.
Latest commit 26feae3 Aug 13, 2013 @nobu nobu random.c: coerce before check negative
* random.c (rb_random_ulong_limited): coerce before check negative.
  [Fixes GH-379]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42542 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Failed to load latest commit information.
benchmark * benchmark/gc/gcbench.rb: fix summary of benchmark result notaton. Jun 21, 2013
bin irb: dead code May 2, 2013
bootstraptest
cygwin * cygwin/GNUmakefile.in (uncommon.mk): link *.res.o. Nov 5, 2012
defs
doc
enc
ext
include * include/ruby/encoding.h: Reduce ENCODING_INLINE_MAX to 127 as this Aug 11, 2013
lib
man * man/ri.1: Incorrect use of .Dd macro [Bug #8620] by Tristan Hill Jul 10, 2013
misc
missing
nacl
sample
spec
symbian
template
test
tool
win32 win32.c: fix conversion Aug 6, 2013
.document * .document: Removed extra space Jan 16, 2013
.editorconfig
.gdbinit .gdbinit: initialize color sequences Mar 7, 2013
.gitignore
.indent.pro
.travis.yml
BSDL
COPYING
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128] Sep 4, 2011
ChangeLog
GPL
KNOWNBUGS.rb * test/ruby/test_method.rb (test_unlinked_method_entry_in_method_obje… Mar 25, 2013
LEGAL
Makefile.in
NEWS
README * README: Fix typo by Benjamin Winkler [Fixes GH-281] Apr 11, 2013
README.EXT
README.EXT.ja
README.ja
addr2line.c * addr2line.c: use more generic type: Apr 6, 2013
addr2line.h
array.c
bignum.c
class.c
common.mk common.mk: install arch Aug 8, 2013
compar.c
compile.c
complex.c
configure.in
constant.h
cont.c
debug.c
dir.c
dln.c
dln.h
dln_find.c
dmydln.c
dmyext.c
encoding.c
enum.c
enumerator.c enumerator.c: fix non-single argument Aug 8, 2013
error.c error.c: evaluate RARRAY_AREF once Jun 20, 2013
eval.c
eval_error.c
eval_intern.h
eval_jump.c
file.c
gc.c
gc.h * gc.h (SET_MACHINE_STACK_END): Add !defined(_ILP32) to a defining May 10, 2013
gem_prelude.rb
golf_prelude.rb
goruby.c
hash.c * hash.c (rb_hash_compare_by_id): add function prototype. Jul 29, 2013
ia64.s
inits.c sizes.c: RbConfig::SIZEOF Jul 29, 2013
insns.def
internal.h
io.c
iseq.c parse.y, vm_eval.c: file encoding in eval Jul 29, 2013
iseq.h
lex.c.blt
load.c
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h Jun 17, 2013
localeinit.c
main.c
marshal.c
math.c
method.h
miniinit.c localeinit.c: split Jul 14, 2013
node.c * include/ruby/util.h: removed extra semicolon in definition of Nov 21, 2012
node.h parse.y, vm_eval.c: file encoding in eval Jul 29, 2013
numeric.c
object.c
pack.c
parse.y
prelude.rb
probes.d
probes_helper.h
proc.c
process.c * process.c: [DOC] RDoc formatting of Process.clock_gettime Aug 12, 2013
random.c random.c: coerce before check negative Aug 13, 2013
range.c
rational.c
re.c
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. Apr 13, 2013
regint.h
regparse.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. Apr 13, 2013
regparse.h
regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] Feb 17, 2012
ruby.c
ruby_atomic.h
safe.c
signal.c signal.c: suppress a warning Jul 14, 2013
siphash.c * regint.h: fix typo: _M_AMD86 -> _M_AMD64. Apr 10, 2013
siphash.h
sizes.c
sparc.c * sparc.c: Use __asm__ instead of asm for gcc. Apr 27, 2013
sprintf.c
st.c
strftime.c
string.c * string.c (rb_str_format_m): use RARRAY_RAWPTR() instead of Aug 8, 2013
struct.c
thread.c
thread_native.h * thread_native.h: add rb_nativethread_self() which returns Jul 23, 2013
thread_pthread.c
thread_pthread.h
thread_win32.c
thread_win32.h
time.c
timev.h
transcode.c encoding.c: refill terminator at associating encoding Jul 12, 2013
transcode_data.h
util.c
variable.c
version.c
version.h
vm.c
vm_backtrace.c
vm_core.h * proc.c: add Binding#local_variable_get/set/defined? Aug 9, 2013
vm_debug.h
vm_dump.c
vm_eval.c
vm_exec.c
vm_exec.h
vm_insnhelper.c
vm_insnhelper.h
vm_method.c
vm_opts.h
vm_trace.c
vsnprintf.c

README

= What's Ruby

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.


== 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
    as well as Windows, Mac OS X, BeOS etc.)
    cf. http://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms


== How to get Ruby

For a complete list of ways to install Ruby, including using third party
tools like rvm, see:

http://www.ruby-lang.org/en/downloads/

The Ruby distribution files can be found in the following FTP site:

ftp://ftp.ruby-lang.org/pub/ruby/

The trunk of the Ruby source tree can be checked out with the
following command:

  $ svn co http://svn.ruby-lang.org/repos/ruby/trunk/ ruby

Or if you are using git then use the following command:

  $ git clone git://github.com/ruby/ruby.git

There are some other branches under development.  Try the following
command and see the list of branches:

  $ svn ls http://svn.ruby-lang.org/repos/ruby/branches/

Or if you are using git then use the following command:

  $ git ls-remote git://github.com/ruby/ruby.git

== Ruby home-page

The URL of the Ruby home-page is:

http://www.ruby-lang.org/


== Mailing list

There is a mailing list to talk about Ruby.
To subscribe this list, please send the following phrase

        subscribe YourFirstName YourFamilyName
e.g.
        subscribe Joseph Smith

in the mail body (not subject) to the address <mailto:ruby-talk-ctl@ruby-lang.org>.


== How to compile and install

This is what you need to do to compile and install Ruby:

0.   If you want to use Microsoft Visual C++ to compile ruby,
     read win32/README.win32 instead of this document.

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.

     Some C compiler flags may be added by default depending on your
     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.

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 "<tt>#option nodynamic</tt>" in
     +ext/Setup+.

     Usually this step will not be needed.

5.   Run +make+.

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 '<tt>make install</tt>'

     This command will create following directories and install files
     onto them.

     * <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.

If you fail to compile ruby, please send the detailed error report with
the error log and machine/OS type, to help others.

Some extension libraries may not get compiled because of lack of
necessary external libraries and/or headers, then you will need to run
'<tt>make distclean-ext</tt>' to remove old configuration after
installing them in such case.

== Copying

See the file +COPYING+.

== Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list
(http://www.ruby-lang.org/en/community/mailing-lists) or on websites like
(http://stackoverflow.com).

Bug reports should be filed at http://bugs.ruby-lang.org

== The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

<mailto:matz@ruby-lang.org>

--
Local variables:
mode: rdoc
end:
Something went wrong with that request. Please try again.