mirror of
https://github.com/mruby/mruby
synced 2026-06-08 16:11:16 +00:00
Matt Aimonetti
108 lines
3.1 KiB
Markdown
108 lines
3.1 KiB
Markdown
# !!Notice!!
|
|
This is a preliminary release for internal team review.
|
|
The URLs and addresses discribed below are not available yet.
|
|
The official release will be announced later.
|
|
Any suggestion for modification is welcome.
|
|
Delays in replies are to be expected. Sorry in advance.
|
|
|
|
## What's mruby
|
|
|
|
mruby is the lightweight implementation of the Ruby language complying to
|
|
the [ISO standard](http://www.ipa.go.jp/about/press/20120402_2.html).
|
|
mruby can run Ruby code in 'interpreter mode' or 'compile and execute it on a virtual machine' depending on how the developer's preference.
|
|
|
|
This achievement was sponsored by the Regional Innovation Creation R&D Programs of
|
|
the Ministry of Economy, Trade and Industry of Japan.
|
|
|
|
|
|
## Features of mruby
|
|
|
|
| Compatibility with MRI(Matz Ruby Implementation) version...
|
|
|
|
|
|FIXME:
|
|
| + Simple Syntax
|
|
| + *Normal* Object-Oriented features(ex. class, method calls)
|
|
| + *Advanced* Object-Oriented features(ex. Mixin, Singleton-method)
|
|
| + Operator Overloading
|
|
| + Exception Handling
|
|
| + Iterators and Closures
|
|
| + Garbage Collection
|
|
| + Dynamic Loading of Object files(on some architecture)
|
|
| + Highly Portable (works on many Unix-like/POSIX compatible platforms
|
|
| as well as Windows, Mac OS X, BeOS etc.)
|
|
| cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms
|
|
|
|
|
|
## How to get mruby
|
|
|
|
The mruby distribution files can be found in the following site:
|
|
|
|
https://github.com/mruby/mruby/zipball/master
|
|
|
|
The trunk of the mruby source tree can be checked out with the
|
|
following command:
|
|
|
|
$ git clone https://github.com/mruby/mruby.git
|
|
|
|
There are some other branches under development. Try the following
|
|
command and see the list of branches:
|
|
|
|
$ git ....
|
|
|
|
|
|
## mruby home-page
|
|
|
|
mruby's website is not launched yet but we are actively working on it.
|
|
|
|
The URL of the mruby home-page will be:
|
|
|
|
http://www.mruby.org/
|
|
|
|
|
|
## Mailing list
|
|
|
|
To subscribe the mruby mailing list....[T.B.D.]
|
|
|
|
|
|
## How to compile and install
|
|
|
|
See the INSTALL file.
|
|
|
|
|
|
## Copying
|
|
|
|
See the COPYING file.
|
|
|
|
|
|
## About Contribution
|
|
|
|
Thank you for considering contributing to mruby.
|
|
mruby has chosen a MIT License due to its permissive license allowing
|
|
developer to target various environments such as embedded systems.
|
|
However, the license requires to display 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 copyright name
|
|
to make it simple conventionally.
|
|
In the future, mruby might ask you to distribute your new codes
|
|
(that you will commit,) under 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.)
|
|
|
|
Please ask us if you want to distribute your code under other license
|
|
or if your code is derived from GPL code.
|
|
|
|
|
|
## The Author
|
|
|
|
See the file AUTHORS.
|
|
|
|
|
|
Feel free to send comments and bug reports to the author. Here is the
|
|
author's latest mail address:
|
|
|
|
devel@mruby.org
|
|
|
|
|