Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 108 lines (67 sloc) 3.225 kb
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
1 # !!Notice!!
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
2 This is a preliminary release for internal team review.
f8de58a Santiago Rodriguez Typo
sanrodari authored
3 The URLs and addresses described below are not available yet.
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
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 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
7
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
8 ## What's mruby
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
9
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
10 mruby is the lightweight implementation of the Ruby language complying to
11 the [ISO standard](http://www.ipa.go.jp/about/press/20120402_2.html).
12 mruby can run Ruby code in 'interpreter mode' or 'compile and execute it on a virtual machine' depending on how the developer's preference.
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
13
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
14 This achievement was sponsored by the Regional Innovation Creation R&D Programs of
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
15 the Ministry of Economy, Trade and Industry of Japan.
16
17
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
18 ## Features of mruby
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
19
7fd85e1 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
20 | Compatibility with MRI(Matz Ruby Implementation) version...
21 |
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
22 |FIXME:
23 | + Simple Syntax
24 | + *Normal* Object-Oriented features(ex. class, method calls)
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
25 | + *Advanced* Object-Oriented features(ex. Mixin, Singleton-method)
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
26 | + Operator Overloading
27 | + Exception Handling
28 | + Iterators and Closures
29 | + Garbage Collection
30 | + Dynamic Loading of Object files(on some architecture)
31 | + Highly Portable (works on many Unix-like/POSIX compatible platforms
32 | as well as Windows, Mac OS X, BeOS etc.)
33 | cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms
34
35
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
36 ## How to get mruby
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
37
38 The mruby distribution files can be found in the following site:
39
40 https://github.com/mruby/mruby/zipball/master
41
42 The trunk of the mruby source tree can be checked out with the
43 following command:
44
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
45 $ git clone https://github.com/mruby/mruby.git
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
46
47 There are some other branches under development. Try the following
48 command and see the list of branches:
49
f7f3118 Masayoshi Takahashi fix git commands
takahashim authored
50 $ git branch -r
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
51
52
62e2871 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
53 ## mruby home-page
54
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
55 mruby's website is not launched yet but we are actively working on it.
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
56
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
57 The URL of the mruby home-page will be:
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
58
59 http://www.mruby.org/
60
61
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
62 ## Mailing list
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
63
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
64 To subscribe the mruby mailing list....[T.B.D.]
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
65
66
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
67 ## How to compile and install
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
68
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
69 See the INSTALL file.
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
70
71
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
72 ## Copying
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
73
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
74 See the COPYING file.
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
75
76
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
77 ## About Contribution
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
78
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
79 Thank you for considering contributing to mruby.
80 mruby has chosen a MIT License due to its permissive license allowing
81 developer to target various environments such as embedded systems.
82 However, the license requires to display the copyright notice and license
83 information in manuals for instance. Doing so for big projects can be
84 complicated or troublesome.
85 This is why, mruby has decided to display "mruby developers" as copyright name
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
86 to make it simple conventionally.
87 In the future, mruby might ask you to distribute your new codes
88 (that you will commit,) under MIT License as a member of
754ab1b Matt Aimonetti updated the English README to fix some minor grammatical and spelling mi...
mattetti authored
89 "mruby developers" but contributors will keep their copyright.
90 (We did not intend for contributors to transfer or waive their copyrights,
91 Actual copyright holder name (contributors) will be listed in the AUTHORS file.)
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
92
93 Please ask us if you want to distribute your code under other license
94 or if your code is derived from GPL code.
95
96
0631d18 Hidetaka Takano Update README.md
TJ-Hidetaka-Takano authored
97 ## The Author
dbb4790 Hidetaka Takano add: markdown README
TJ-Hidetaka-Takano authored
98
99 See the file AUTHORS.
100
101
102 Feel free to send comments and bug reports to the author. Here is the
103 author's latest mail address:
104
105 devel@mruby.org
106
9454ff8 Hidetaka Takano Del: notation
TJ-Hidetaka-Takano authored
107
Something went wrong with that request. Please try again.