Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 149 lines (98 sloc) 4.893 kb
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
1 = What's Ruby
3db12e8 Initial revision
matz authored
2
3 Ruby is the interpreted scripting language for quick and
4 easy object-oriented programming. It has many features to
5 process text files and to do system management tasks (as in
210367e This commit was generated by cvs2svn to compensate for changes in r372,
matz authored
6 Perl). It is simple, straight-forward, and extensible.
3db12e8 Initial revision
matz authored
7
cbc3756 @knu * It is confusing to put the GPL license terms in the file COPYING;
knu authored
8
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
9 == Features of Ruby
3db12e8 Initial revision
matz authored
10
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
11 * Simple Syntax
12 * *Normal* Object-Oriented features(ex. class, method calls)
13 * *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
14 * Operator Overloading
15 * Exception Handling
16 * Iterators and Closures
17 * Garbage Collection
18 * Dynamic Loading of Object files(on some architecture)
19 * Highly Portable (works on many Unix-like/POSIX compatible platforms
c93ac53 @knu * README, README.ja: Update the portability section.
knu authored
20 as well as Windows, Mac OS X, BeOS etc.)
8010126 @drbrain * README.ja: Update redmine.ruby-lang.org to bugs.ruby-lang.org
drbrain authored
21 cf. http://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms
3db12e8 Initial revision
matz authored
22
cbc3756 @knu * It is confusing to put the GPL license terms in the file COPYING;
knu authored
23
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
24 == How to get Ruby
3db12e8 Initial revision
matz authored
25
74adb2b @knu Update the distribution information.
knu authored
26 The Ruby distribution files can be found in the following FTP site:
3db12e8 Initial revision
matz authored
27
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
28 ftp://ftp.ruby-lang.org/pub/ruby/
3db12e8 Initial revision
matz authored
29
74adb2b @knu Update the distribution information.
knu authored
30 The trunk of the Ruby source tree can be checked out with the
31 following command:
65a5162 1.4.0
matz authored
32
74adb2b @knu Update the distribution information.
knu authored
33 $ svn co http://svn.ruby-lang.org/repos/ruby/trunk/ ruby
34
c5335bd @ayumin * README: add comment for Git user. patch from Arun Agrawal.
ayumin authored
35 Or if you are using git then use following command:
36
37 $ git clone git://github.com/ruby/ruby.git
38
74adb2b @knu Update the distribution information.
knu authored
39 There are some other branches under development. Try the following
40 command and see the list of branches:
41
42 $ svn ls http://svn.ruby-lang.org/repos/ruby/branches/
65a5162 1.4.0
matz authored
43
c5335bd @ayumin * README: add comment for Git user. patch from Arun Agrawal.
ayumin authored
44 Or if you are using git then use following command:
45
46 $ git ls-remote git://github.com/ruby/ruby.git
cbc3756 @knu * It is confusing to put the GPL license terms in the file COPYING;
knu authored
47
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
48 == Ruby home-page
cbc3756 @knu * It is confusing to put the GPL license terms in the file COPYING;
knu authored
49
50 The URL of the Ruby home-page is:
51
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
52 http://www.ruby-lang.org/
cbc3756 @knu * It is confusing to put the GPL license terms in the file COPYING;
knu authored
53
54
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
55 == Mailing list
65a5162 1.4.0
matz authored
56
57 There is a mailing list to talk about Ruby.
58 To subscribe this list, please send the following phrase
59
7152df6 990918-repack
matz authored
60 subscribe YourFirstName YourFamilyName
65a5162 1.4.0
matz authored
61 e.g.
62 subscribe Joseph Smith
63
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
64 in the mail body (not subject) to the address <mailto:ruby-talk-ctl@ruby-lang.org>.
65a5162 1.4.0
matz authored
65
cbc3756 @knu * It is confusing to put the GPL license terms in the file COPYING;
knu authored
66
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
67 == How to compile and install
3db12e8 Initial revision
matz authored
68
7ea2ced This commit was generated by cvs2svn to compensate for changes in r11,
matz authored
69 This is what you need to do to compile and install Ruby:
3db12e8 Initial revision
matz authored
70
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
71 1. If +./configure+ does not exist or is older than configure.in,
ceec42b matz
matz authored
72 run autoconf to (re)generate configure.
3db12e8 Initial revision
matz authored
73
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
74 2. Run +./configure+, which will generate config.h and Makefile.
3db12e8 Initial revision
matz authored
75
2b9f74d @knu * README, README.ja: Add a note about default C flags.
knu authored
76 Some C compiler flags may be added by default depending on your
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
77 environment. Specify <tt>optflags=..</tt> and <tt>warnflags=..</tt> as
78 necessary to override them.
2b9f74d @knu * README, README.ja: Add a note about default C flags.
knu authored
79
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
80 3. Edit +defines.h+ if you need. Usually this step will not be needed.
ceec42b matz
matz authored
81
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
82 4. Remove comment mark(<tt>#</tt>) before the module names from +ext/Setup+ (or
210367e This commit was generated by cvs2svn to compensate for changes in r372,
matz authored
83 add module names if not present), if you want to link modules
84 statically.
3db12e8 Initial revision
matz authored
85
210367e This commit was generated by cvs2svn to compensate for changes in r372,
matz authored
86 If you don't want to compile non static extension modules
87 (probably on architectures which does not allow dynamic loading),
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
88 remove comment mark from the line "<tt>#option nodynamic</tt>" in
89 +ext/Setup+.
3db12e8 Initial revision
matz authored
90
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
91 5. Run +make+.
3db12e8 Initial revision
matz authored
92
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
93 6. Optionally, run '<tt>make check</tt>' to check whether the compiled Ruby
94 interpreter works well. If you see the message "<tt>check succeeded</tt>",
210367e This commit was generated by cvs2svn to compensate for changes in r372,
matz authored
95 your ruby works as it should (hopefully).
3db12e8 Initial revision
matz authored
96
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
97 7. Run '<tt>make install</tt>'
3db12e8 Initial revision
matz authored
98
0f7321e @nobu * README: update.
nobu authored
99 This command will create following directories and install files
100 onto them.
101
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
102 * <tt>${DESTDIR}${prefix}/bin</tt>
103 * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</tt>
104 * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
105 * <tt>${DESTDIR}${prefix}/lib</tt>
106 * <tt>${DESTDIR}${prefix}/lib/ruby</tt>
107 * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
108 * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
109 * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby</tt>
110 * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
111 * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
112 * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</tt>
113 * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
114 * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
115 * <tt>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</tt>
116 * <tt>${DESTDIR}${prefix}/share/man/man1</tt>
117 * <tt>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</tt>
118
aa913eb @nobu single quotes
nobu authored
119 If Ruby's API version is '_x.y.z_', the <tt>${MAJOR}</tt> is '_x_', the
120 <tt>${MINOR}</tt> is '_y_', and the <tt>${TEENY}</tt> is '_z_'.
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
121
122 *NOTE*: teeny of the API version may be different from one of
0f7321e @nobu * README: update.
nobu authored
123 Ruby's program version
124
210367e This commit was generated by cvs2svn to compensate for changes in r372,
matz authored
125 You may have to be a super user to install ruby.
126
127 If you fail to compile ruby, please send the detailed error report with
3db12e8 Initial revision
matz authored
128 the error log and machine/OS type, to help others.
129
7ea2ced This commit was generated by cvs2svn to compensate for changes in r11,
matz authored
130
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
131 == Copying
3db12e8 Initial revision
matz authored
132
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
133 See the file +COPYING+.
3db12e8 Initial revision
matz authored
134
135
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
136 == The Author
3db12e8 Initial revision
matz authored
137
a6e30a8 @znz * README*: remove trailing spaces.
znz authored
138 Feel free to send comments and bug reports to the author. Here is the
3db12e8 Initial revision
matz authored
139 author's latest mail address:
140
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
141 <mailto:matz@ruby-lang.org>
3db12e8 Initial revision
matz authored
142
143 -------------------------------------------------------
144 created at: Thu Aug 3 11:57:36 JST 1995
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
145 --
3db12e8 Initial revision
matz authored
146 Local variables:
8de9bb2 @nobu * README, README.ja: reformatted using rdoc markup. based on the
nobu authored
147 mode: rdoc
3db12e8 Initial revision
matz authored
148 end:
Something went wrong with that request. Please try again.