-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathfile.README.html
206 lines (197 loc) · 10 KB
/
file.README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, user-scalable=no'>
<meta name='apple-touch-fullscreen' content='yes'>
<meta name='apple-mobile-web-app-capable' content='yes'>
<meta name='apple-mobile-web-app-status-bar-style' content='rgba(228,228,228,1.0)'>
<title>File: README — Ruby-2.6.10</title>
<link rel='stylesheet' type='text/css' href='../css/y_fonts.css' />
<link rel='stylesheet' type='text/css' href='../css/highlight.github.css' />
<link rel='stylesheet' type='text/css' href='../css/y_style.css' />
<link rel='stylesheet' type='text/css' href='../css/y_list.css' />
<link rel='stylesheet' type='text/css' href='../css/y_color.css' />
<script type='text/javascript'>
var pathId = "README",
relpath = '';
var t2Info = {
CSEP: '.',
ISEP: '#',
NSEP: '::'
};
</script>
<script type='text/javascript' charset='utf-8' src='../js/highlight.pack.js'></script>
<script type='text/javascript' charset='utf-8' src='../js/y_app.js'></script>
</head>
<body>
<svg id='y_wait' class viewBox='0 0 90 90'></svg>
<div id='settings' class='hidden'></div>
<div id='y_list' class='d h'>
<header id='list_header'></header>
<nav id= 'list_nav' class='y_nav l_nav'>
<ul id='list_items'></ul>
</nav>
</div>
<div id='y_toc' class='f h'>
<header id='toc_header'></header>
<nav id= 'toc_nav' class='y_nav t_nav'>
<ol id='toc_items'></ol>
</nav>
</div>
<div id='y_main' tabindex='-1'>
<header id='y_header'>
<div id='y_menu'>
<a id='home_no_xhr' href='/'>Home</a> »
<a href='.'>Ruby-2.6.10</a> »
<a href='_index.html'>Index</a> »
<span class='title'><a id='t2_doc_top' href='#'>File: README ▲</a></span>
</div>
<a id='list_href' href="file_list.html"></a>
<div id='y_measure_em' class='y_measure'></div>
<div id='y_measure_vh' class='y_measure'></div>
<span id='y_measure_50pre' class='y_measure'><code>123456789_123456789_123456789_123456789_123456789_</code></span>
</header>
<div id='content' class='file'>
<p><a href="https://travis-ci.org/ruby/ruby"><img src="https://travis-ci.org/ruby/ruby.svg?branch=trunk" alt="Build Status" /></a>
<a href="https://ci.appveyor.com/project/ruby/ruby/branch/trunk"><img src="https://ci.appveyor.com/api/projects/status/0sy8rrxut4o0k960/branch/trunk?svg=true" alt="Build status" /></a>
<a href="https://app.wercker.com/project/byKey/e5e7e1704f62b76525022aa424aef6ef"><img src="https://app.wercker.com/status/e5e7e1704f62b76525022aa424aef6ef/s/trunk" alt="wercker status" title="wercker status" /></a></p>
<h1>What's Ruby</h1>
<p>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.</p>
<h2>Features of Ruby</h2>
<ul>
<li>Simple Syntax</li>
<li><strong>Normal</strong> Object-oriented Features (e.g. class, method calls)</li>
<li><strong>Advanced</strong> Object-oriented Features (e.g. mix-in, singleton-method)</li>
<li>Operator Overloading</li>
<li>Exception Handling</li>
<li>Iterators and Closures</li>
<li>Garbage Collection</li>
<li>Dynamic Loading of Object Files (on some architectures)</li>
<li>Highly Portable (works on many Unix-like/POSIX compatible platforms as
well as Windows, macOS, Haiku, etc.) cf.
<a href="https://github.com/ruby/ruby/blob/trunk/doc/contributing.rdoc#platform-maintainers">https://github.com/ruby/ruby/blob/trunk/doc/contributing.rdoc#platform-maintainers</a></li>
</ul>
<h2>How to get Ruby</h2>
<p>For a complete list of ways to install Ruby, including using third-party tools
like rvm, see:</p>
<p><a href="https://www.ruby-lang.org/en/downloads/">https://www.ruby-lang.org/en/downloads/</a></p>
<p>The trunk of the Ruby source tree can be checked out with the following
command:</p>
<pre class="code ruby"><code class="ruby">$ svn co https://svn.ruby-lang.org/repos/ruby/trunk/ ruby</code></pre>
<p>Or if you are using git then use the following command:</p>
<pre class="code ruby"><code class="ruby">$ git clone https://github.com/ruby/ruby.git</code></pre>
<p>There are some other branches under development. Try the following command
to see the list of branches:</p>
<pre class="code ruby"><code class="ruby">$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/</code></pre>
<p>Or if you are using git then use the following command:</p>
<pre class="code ruby"><code class="ruby">$ git ls-remote https://github.com/ruby/ruby.git</code></pre>
<h2>Ruby home page</h2>
<p>The URL of the Ruby home page is:</p>
<p><a href="https://www.ruby-lang.org/">https://www.ruby-lang.org/</a></p>
<h2>Mailing list</h2>
<p>There is a mailing list to talk about Ruby. To subscribe to this list, please
send the following phrase:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_subscribe'>subscribe</span></code></pre>
<p>in the mail body (not subject) to the address
<a href="mailto:[email protected]">[email protected]</a>.</p>
<h2>How to compile and install</h2>
<p>This is what you need to do to compile and install Ruby:</p>
<ol>
<li>
<p>If you want to use Microsoft Visual C++ to compile Ruby, read
<a href="file.README.win32.html" title="win32/README.win32">win32/README.win32</a> instead of this document.</p>
</li>
<li>
<p>If <code>./configure</code> does not exist or is older than <code>configure.ac</code>, run
<code>autoconf</code> to (re)generate configure.</p>
</li>
<li>
<p>Run <code>./configure</code>, which will generate <code>config.h</code> and <code>Makefile</code>.</p>
<p>Some C compiler flags may be added by default depending on your
environment. Specify <code>optflags=..</code> and <code>warnflags=..</code> as necessary to
override them.</p>
</li>
<li>
<p>Edit <code>defines.h</code> if you need. Usually this step will not be needed.</p>
</li>
<li>
<p>Remove comment mark(<code>#</code>) before the module names from <code>ext/Setup</code> (or add
module names if not present), if you want to link modules statically.</p>
<p>If you don't want to compile non static extension modules (probably on
architectures which do not allow dynamic loading), remove comment mark
from the line "<code>#option nodynamic</code>" in <code>ext/Setup</code>.</p>
<p>Usually this step will not be needed.</p>
</li>
<li>
<p>Run <code>make</code>.</p>
<ul>
<li>On Mac, set RUBY_CODESIGN environment variable with a signing identity.
It uses the identity to sign <code>ruby</code> binary. See also codesign(1).</li>
</ul>
</li>
<li>
<p>Optionally, run '<code>make check</code>' to check whether the compiled Ruby
interpreter works well. If you see the message "<code>check succeeded</code>", your
Ruby works as it should (hopefully).</p>
</li>
<li>
<p>Optionally, run <code>make update-gems</code> and <code>make extract-gems</code>.</p>
<p>If you want to install bundled gems, run <code>make update-gems</code> and
<code>make extract-gems</code> before running <code>make install</code>.</p>
</li>
<li>
<p>Run '<code>make install</code>'.</p>
<p>This command will create the following directories and install files into
them.</p>
<ul>
<li><code>${DESTDIR}${prefix}/bin</code></li>
<li><code>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</code></li>
<li><code>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</code></li>
<li><code>${DESTDIR}${prefix}/lib</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/site_ruby</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</code></li>
<li><code>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</code></li>
<li><code>${DESTDIR}${prefix}/share/man/man1</code></li>
<li><code>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</code></li>
</ul>
<p>If Ruby's API version is '<em>x.y.z</em>', the <code>${MAJOR}</code> is '<em>x</em>', the
<code>${MINOR}</code> is '<em>y</em>', and the <code>${TEENY}</code> is '<em>z</em>'.</p>
<p><strong>NOTE</strong>: teeny of the API version may be different from one of Ruby's
program version</p>
<p>You may have to be a super user to install Ruby.</p>
</li>
</ol>
<p>If you fail to compile Ruby, please send the detailed error report with the
error log and machine/OS type, to help others.</p>
<p>Some extension libraries may not get compiled because of lack of necessary
external libraries and/or headers, then you will need to run '<code>make distclean-ext</code>'
to remove old configuration after installing them in such case.</p>
<h2>Copying</h2>
<p>See the file <a href="file.COPYING.html" title="COPYING">COPYING</a>.</p>
<h2>Feedback</h2>
<p>Questions about the Ruby language can be asked on the Ruby-Talk mailing list
(<a href="https://www.ruby-lang.org/en/community/mailing-lists">https://www.ruby-lang.org/en/community/mailing-lists</a>) or on websites like
(<a href="https://stackoverflow.com">https://stackoverflow.com</a>).</p>
<p>Bug reports should be filed at <a href="https://bugs.ruby-lang.org">https://bugs.ruby-lang.org</a>. Read <a href="https://bugs.ruby-lang.org/projects/ruby/wiki/HowToReport">HowToReport</a> for more information.</p>
<h2>Contributing</h2>
<p>See the file <a href="file.CONTRIBUTING.html" title="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
<h2>The Author</h2>
<p>Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in
1995.</p>
<p><a href="mailto:[email protected]">[email protected]</a></p>
<div id='footer'></div>
</div> <!-- content -->
</div> <!-- y_main -->
</body>
</html>