forked from mruby/mruby.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfile.README.html
More file actions
180 lines (121 loc) · 7.21 KB
/
file.README.html
File metadata and controls
180 lines (121 loc) · 7.21 KB
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
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
— Documentation by YARD 0.9.20
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/mruby.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="js/mruby.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><p><a href="https://travis-ci.org/mruby/mruby"><img src="https://travis-ci.org/mruby/mruby.svg?branch=master" alt="Build Status" /></a></p>
<h2 id="what-is-mruby">What is mruby</h2>
<p>mruby is the lightweight implementation of the Ruby language complying to (part
of) the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579">ISO standard</a>. Its syntax is Ruby 2.x compatible.</p>
<p>mruby can be linked and embedded within your application. We provide the
interpreter program “mruby” and the interactive mruby shell “mirb” as examples.
You can also compile Ruby programs into compiled byte code using the mruby
compiler “mrbc”. All those tools reside in the “bin” directory. “mrbc” is
also able to generate compiled byte code in a C source file, see the “mrbtest”
program under the “test” directory for an example.</p>
<p>This achievement was sponsored by the Regional Innovation Creation R&D Programs
of the Ministry of Economy, Trade and Industry of Japan.</p>
<h2 id="how-to-get-mruby">How to get mruby</h2>
<p>The stable version 2.1.0 of mruby can be downloaded via the following URL: <a href="https://github.com/mruby/mruby/archive/2.1.0.zip">https://github.com/mruby/mruby/archive/2.1.0.zip</a></p>
<p>The latest development version of mruby can be downloaded via the following URL: <a href="https://github.com/mruby/mruby/zipball/master">https://github.com/mruby/mruby/zipball/master</a></p>
<p>The trunk of the mruby source tree can be checked out with the
following command:</p>
<pre class="code ruby"><code class="ruby"><span style="color:#F00;background-color:#FAA">$</span> git clone <span style="color:#606">https</span>:<span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span>github.com/mruby/mruby.git
</code></pre>
<p>You can also install and compile mruby using <a href="https://github.com/postmodern/ruby-install">ruby-install</a>, <a href="https://github.com/rbenv/ruby-build">ruby-build</a> or <a href="https://github.com/rvm/rvm">rvm</a>.</p>
<h2 id="mruby-home-page">mruby home-page</h2>
<p>The URL of the mruby home-page is: <a href="http://www.mruby.org">http://www.mruby.org</a>.</p>
<h2 id="mailing-list">Mailing list</h2>
<p>We don’t have a mailing list, but you can use <a href="https://github.com/mruby/mruby">GitHub issues</a>.</p>
<h2 id="how-to-compile-and-install-mruby-and-gems">How to compile and install (mruby and gems)</h2>
<p>See the <a href="https://github.com/mruby/mruby/blob/master/doc/guides/compile.md">compile.md</a> file.</p>
<h2 id="running-tests">Running Tests</h2>
<p>To run the tests, execute the following from the project’s root directory.</p>
<pre class="code ruby"><code class="ruby"><span style="color:#F00;background-color:#FAA">$</span> make test
</code></pre>
<p>Or</p>
<pre class="code ruby"><code class="ruby"><span style="color:#F00;background-color:#FAA">$</span> ruby ./minirake test
</code></pre>
<h2 id="building-documentation">Building documentation</h2>
<p>There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen)</p>
<p>To build both of them, simply go</p>
<pre class="code ruby"><code class="ruby">rake doc
</code></pre>
<p>You can also view them in your browser</p>
<pre class="code ruby"><code class="ruby">rake view_api
rake view_capi
</code></pre>
<h2 id="how-to-customize-mruby-mrbgems">How to customize mruby (mrbgems)</h2>
<p>mruby contains a package manager called <em>mrbgems</em>. To create extensions
in C and/or Ruby you should create a <em>GEM</em>. For a documentation of how to
use mrbgems consult the file <a href="https://github.com/mruby/mruby/blob/master/doc/guides/mrbgems.md">mrbgems.md</a>.
For example code of how to use mrbgems look into the folder <em>examples/mrbgems/</em>.</p>
<h2 id="license">License</h2>
<p>mruby is released under the <a href="https://github.com/mruby/mruby/blob/master/LICENSE">MIT License</a>.</p>
<h2 id="note-for-license">Note for License</h2>
<p>mruby has chosen a MIT License due to its permissive license allowing
developers to target various environments such as embedded systems.
However, the license requires the display of the copyright notice and license
information in manuals for instance. Doing so for big projects can be
complicated or troublesome. This is why mruby has decided to display “mruby
developers” as the copyright name to make it simple conventionally.
In the future, mruby might ask you to distribute your new code
(that you will commit,) under the MIT License as a member of
“mruby developers” but contributors will keep their copyright.
(We did not intend for contributors to transfer or waive their copyrights,
Actual copyright holder name (contributors) will be listed in the AUTHORS
file.)</p>
<p>Please ask us if you want to distribute your code under another license.</p>
<h2 id="how-to-contribute">How to Contribute</h2>
<p>See the <a href="https://github.com/mruby/mruby/blob/master/CONTRIBUTING.md">contribution guidelines</a>, and then send a pull
request to <a href="http://github.com/mruby/mruby">http://github.com/mruby/mruby</a>. We consider you have granted
non-exclusive right to your contributed code under MIT license. If you want to
be named as one of mruby developers, please include an update to the AUTHORS
file in your pull request.</p>
</div></div>
<div id="footer">
Generated on Wed Nov 27 22:35:07 2019 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.20 in <a href="https://github.com/sagmor/yard-mruby">mruby mode</a> 0.3.0 (ruby-2.5.5).
</div>
</div>
</body>
</html>