1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
akr 8fcdb757a5 * process.c (rb_f_exec): use rb_exec_arg_prepare.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@36000 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-06-10 01:17:53 +00:00
bcc32 * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +00:00
benchmark
bin
bootstraptest
cygwin
defs * tool/rbinstall.rb (gem): install all gemspecs under lib and ext. 2011-08-04 07:08:48 +00:00
doc
enc
ext
include
lib
man
misc * misc/rdoc-mode.el (rdoc-imenu-create-index): Add imenu support 2012-01-22 15:56:03 +00:00
missing
nacl
sample
spec
symbian
template
test
tool test: realpath 2012-06-08 07:19:38 +00:00
win32
.document * prelude.rb, .document: Stuff in prelude.rb should be documented 2010-03-29 12:48:43 +00:00
.gdbinit * .gdbinit: add function `trace_machine_instructions' to trace 2012-06-07 06:54:24 +00:00
.gitignore * ext/iconv: deprecated. [Feature ] 2012-04-23 13:57:53 +00:00
.indent.pro
.travis.yml * .travis.yml (install): It seems tcl/tk is skipped in Travis 2012-05-21 03:45:52 +00:00
addr2line.c * io.c (io_encoding_set): suppress warnings. [ruby-dev:45627] 2012-05-06 12:39:59 +00:00
addr2line.h
array.c
atomic.h
bignum.c
BSDL
ChangeLog
class.c
common.mk
compar.c
compile.c * vm_core.h (rb_location_t): fix type and field name. 2012-06-04 02:49:37 +00:00
complex.c * marshal.c: experimental test aborted. 2012-06-03 19:26:58 +00:00
configure.in
constant.h
cont.c decrease fiber stack size. 1MB is too large for windows. [Bug ] 2012-05-18 09:10:46 +00:00
COPYING
COPYING.ja
debug.c
debug.h
dir.c
dln.c Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c
enum.c * enum.c (enum_count): Enumerable#count no longer uses #size when 2012-05-24 23:51:56 +00:00
enumerator.c
error.c
eval.c * vm_insnhelper.h: remove magical code "lfp[0] & 0x02". 2012-06-04 07:24:44 +00:00
eval_error.c
eval_intern.h
eval_jump.c
file.c obj_init_copy 2012-06-05 11:13:18 +00:00
gc.c
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug ] 2012-06-03 13:07:58 +00:00
hash.c
ia64.s
id.c
inits.c
insns.def
internal.h string.c: rb_str_symname_p 2012-06-09 14:36:17 +00:00
io.c
iseq.c
iseq.h
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c
main.c
Makefile.in Bug : EXTSOLIBS 2012-05-20 03:25:14 +00:00
marshal.c
math.c
method.h
NEWS * removed trailing spaces. 2012-06-09 21:36:05 +00:00
node.c
node.h * enumerator.c (lazy_take): add Enumerable::Lazy#take. 2012-03-14 10:29:25 +00:00
numeric.c * reduce UNREACHABLE. 2012-04-15 00:06:13 +00:00
object.c
pack.c use RB_TYPE_P() instead of comparison of TYPE() 2012-05-23 07:13:21 +00:00
parse.y
prelude.rb
proc.c
process.c
random.c
range.c
rational.c
re.c
README
README.EXT * README.EXT (prepare extconf.rb): Added note to see MakeMakefile for 2012-06-08 23:21:50 +00:00
README.EXT.ja
README.ja
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c
safe.c
signal.c
sparc.c
sprintf.c
st.c
strftime.c
string.c string.c: rb_str_symname_p 2012-06-09 14:36:17 +00:00
struct.c
thread.c
thread_pthread.c thread_pthread.c: use stack info 2012-06-08 23:30:55 +00:00
thread_pthread.h
thread_win32.c
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c
timev.h
transcode.c
transcode_data.h
util.c
variable.c
version.c
version.h
vm.c
vm_backtrace.c
vm_core.h
vm_dump.c
vm_eval.c
vm_exec.c * vm_exec.c: remove conditions for clang 2011-05-31 02:08:58 +00:00
vm_exec.h
vm_insnhelper.c * vm_core.h (rb_location_t): fix type and field name. 2012-06-04 02:49:37 +00:00
vm_insnhelper.h
vm_method.c
vm_opts.h
vsnprintf.c

= 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

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 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 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:

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

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.


== Copying

See the file +COPYING+.


== The Author

Feel free to send comments and bug reports to the author.  Here is the
author's latest mail address:

<mailto:matz@ruby-lang.org>

-------------------------------------------------------
created at: Thu Aug  3 11:57:36 JST 1995
--
Local variables:
mode: rdoc
end: