Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 106 lines (70 sloc) 4.11 kB
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
1 # !!Notice!!
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
2 This is a preliminary release for internal team review.
f8de58a @sanrodari Typo
sanrodari authored
3 The URLs and addresses described below are not available yet.
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
4 The official release will be announced later.
5 Any suggestion for modification is welcome.
6 Delays in replies are to be expected. Sorry in advance.
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
7
0631d18 @TJ-Hidetaka-Takano Update README.md
TJ-Hidetaka-Takano authored
8 ## What's mruby
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
9
55920a7 @matz update the desciption regarding comforming to ISO, and provided tools
matz authored
10 mruby is the lightweight implementation of the Ruby language complying to (part of)
2cc0623 @matz update ISO link URL from Japanese page
matz authored
11 the [ISO standard](http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579).
55920a7 @matz update the desciption regarding comforming to ISO, and provided tools
matz authored
12 mruby can be linked and embedded within your application. We provide the interpreter program "mruby" and
13 the interactive mruby shell "mirb" as examples. You can also compile Ruby programs into compiled byte code
14 using the mruby compiler "mrbc". All those tools reside in "bin" directory. The "mrbc" is also able to
15 generate compiled byte code in a C source file. You can check the "mrbtest" program under the "test" directory.
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
16
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
17 This achievement was sponsored by the Regional Innovation Creation R&D Programs of
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
18 the Ministry of Economy, Trade and Industry of Japan.
19
20
0631d18 @TJ-Hidetaka-Takano Update README.md
TJ-Hidetaka-Takano authored
21 ## How to get mruby
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
22
23 The mruby distribution files can be found in the following site:
24
25 https://github.com/mruby/mruby/zipball/master
26
27 The trunk of the mruby source tree can be checked out with the
28 following command:
29
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
30 $ git clone https://github.com/mruby/mruby.git
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
31
e4afcf6 Made text edits to README.md to improve clarity.
Nicholas authored
32 There are some other branches under development. Try the following
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
33 command and see the list of branches:
34
f7f3118 @takahashim fix git commands
takahashim authored
35 $ git branch -r
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
36
37
62e2871 @TJ-Hidetaka-Takano Update README.md
TJ-Hidetaka-Takano authored
38 ## mruby home-page
39
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
40 mruby's website is not launched yet but we are actively working on it.
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
41
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
42 The URL of the mruby home-page will be:
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
43
44 http://www.mruby.org/
45
46
0631d18 @TJ-Hidetaka-Takano Update README.md
TJ-Hidetaka-Takano authored
47 ## Mailing list
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
48
e4afcf6 Made text edits to README.md to improve clarity.
Nicholas authored
49 To subscribe to the mruby mailing list....[T.B.D.]
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
50
51
0631d18 @TJ-Hidetaka-Takano Update README.md
TJ-Hidetaka-Takano authored
52 ## How to compile and install
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
53
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
54 See the INSTALL file.
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
55
4ef8c5a @joequery Add more info on how to run tests
joequery authored
56 ## Running Tests
57
58 To run the tests, execute the following from the project's root directory.
59
60 $ make test
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
61
984e188 @matz update licensing issue and how to contribute
matz authored
62 ## License
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
63
984e188 @matz update licensing issue and how to contribute
matz authored
64 Copyright (c) 2012 mruby developers
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
65
984e188 @matz update licensing issue and how to contribute
matz authored
66 Permission is hereby granted, free of charge, to any person obtaining a
67 copy of this software and associated documentation files (the "Software"),
68 to deal in the Software without restriction, including without limitation
69 the rights to use, copy, modify, merge, publish, distribute, sublicense,
70 and/or sell copies of the Software, and to permit persons to whom the
71 Software is furnished to do so, subject to the following conditions:
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
72
984e188 @matz update licensing issue and how to contribute
matz authored
73 The above copyright notice and this permission notice shall be included in
74 all copies or substantial portions of the Software.
75
76 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
77 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
78 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
79 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
80 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
81 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
82 DEALINGS IN THE SOFTWARE.
83
84 ## Note for License
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
85
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
86 mruby has chosen a MIT License due to its permissive license allowing
e4afcf6 Made text edits to README.md to improve clarity.
Nicholas authored
87 developers to target various environments such as embedded systems.
88 However, the license requires the display of the copyright notice and license
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
89 information in manuals for instance. Doing so for big projects can be
90 complicated or troublesome.
e4afcf6 Made text edits to README.md to improve clarity.
Nicholas authored
91 This is why mruby has decided to display "mruby developers" as the copyright name
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
92 to make it simple conventionally.
e4afcf6 Made text edits to README.md to improve clarity.
Nicholas authored
93 In the future, mruby might ask you to distribute your new code
94 (that you will commit,) under the MIT License as a member of
754ab1b @mattetti updated the English README to fix some minor grammatical and spelling…
mattetti authored
95 "mruby developers" but contributors will keep their copyright.
96 (We did not intend for contributors to transfer or waive their copyrights,
97 Actual copyright holder name (contributors) will be listed in the AUTHORS file.)
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
98
984e188 @matz update licensing issue and how to contribute
matz authored
99 Please ask us if you want to distribute your code under another license.
dbb4790 @TJ-Hidetaka-Takano add: markdown README
TJ-Hidetaka-Takano authored
100
984e188 @matz update licensing issue and how to contribute
matz authored
101 ## How to Contribute
9454ff8 @TJ-Hidetaka-Takano Del: notation
TJ-Hidetaka-Takano authored
102
984e188 @matz update licensing issue and how to contribute
matz authored
103 Send pull request to <http://github.com/mruby/mruby>. We consider you have granted
104 non-exclusive right to your contributed code under MIT license. If you want to be named
105 as one of mruby developers, include update to the AUTHORS file in your pull request.
Something went wrong with that request. Please try again.