Skip to content

M
mruby
Commit dbb4790c authored by Hidetaka Takano's avatar Hidetaka Takano
Browse files
Options

add: markdown README

parent 34e376e0
Hide whitespace changes
Inline Side-by-side
Showing with 133 additions and 23 deletions
README
View file @ dbb4790c
!!Notice!! This is a preliminary release for internal team reviewing. !!Notice!!
The URL and address discribed below are not available yet. This is a preliminary release for internal team reviewing.
The official release will be announced later. Thanks. The URL and address discribed below are not available yet.
Any suggestion of the modification are welcome, The official release will be announced later. Thanks.
but the response might be delayed. Sorry for that in advance. Any suggestion of the modification are welcome,
but the response might be delayed. Sorry for that in advance.
* What's mruby * What's mruby
mruby is the light-weight implementation of the Ruby language complied to the ISO mruby is the light-weight implementation of the Ruby language complied to
standard to execute various environments. It can run in 'interpreter form' or the ISO standard to execute various environments. It can run in 'interpreter
'compile and execute on vm form' according to its module construction. form' or 'compile and execute on vm form' according to its module construction.
This achievement is due to the Regional Innovation Creation R&D Programs of This achievement is due to the Regional Innovation Creation R&D Programs of
the Ministry of Economy, Trade and Industry of Japan. the Ministry of Economy, Trade and Industry of Japan.
...@@ -16,18 +17,18 @@ the Ministry of Economy, Trade and Industry of Japan. ...@@ -16,18 +17,18 @@ the Ministry of Economy, Trade and Industry of Japan.
* Features of mruby * Features of mruby
|FIXME: |FIXME:
| + Simple Syntax | + Simple Syntax
| + *Normal* Object-Oriented features(ex. class, method calls) | + *Normal* Object-Oriented features(ex. class, method calls)
| + *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method) | + *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
| + Operator Overloading | + Operator Overloading
| + Exception Handling | + Exception Handling
| + Iterators and Closures | + Iterators and Closures
| + Garbage Collection | + Garbage Collection
| + Dynamic Loading of Object files(on some architecture) | + Dynamic Loading of Object files(on some architecture)
| + Highly Portable (works on many Unix-like/POSIX compatible platforms | + Highly Portable (works on many Unix-like/POSIX compatible platforms
| as well as Windows, Mac OS X, BeOS etc.) | as well as Windows, Mac OS X, BeOS etc.)
| cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms | cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms
* How to get mruby * How to get mruby
...@@ -39,19 +40,19 @@ The mruby distribution files can be found in the following site: ...@@ -39,19 +40,19 @@ The mruby distribution files can be found in the following site:
The trunk of the mruby source tree can be checked out with the The trunk of the mruby source tree can be checked out with the
following command: following command:
$ git .... $ git ....
There are some other branches under development. Try the following There are some other branches under development. Try the following
command and see the list of branches: command and see the list of branches:
$ git .... $ git ....
* mruby home-page (sorry, it's not launched yet. we're working on this) * mruby home-page (sorry, it's not launched yet. we're working on this)
The URL of the mruby home-page is: The URL of the mruby home-page is:
http://www.mruby.org/ http://www.mruby.org/
* Mailing list * Mailing list
...@@ -59,6 +60,7 @@ The URL of the mruby home-page is: ...@@ -59,6 +60,7 @@ The URL of the mruby home-page is:
There is a mailing list to talk about mruby. There is a mailing list to talk about mruby.
To subscribe this list....[T.B.D.] To subscribe this list....[T.B.D.]
* How to compile and install * How to compile and install
See the file INSTALL. See the file INSTALL.
......
README.md 0 → 100644
View file @ dbb4790c
# !!Notice!!
This is a preliminary release for internal team reviewing.
The URL and address discribed below are not available yet.
The official release will be announced later. Thanks.
Any suggestion of the modification are welcome,
but the response might be delayed. Sorry for that in advance.
# What's mruby
mruby is the light-weight implementation of the Ruby language complied to
the ISO standard to execute various environments. It can run in 'interpreter
form' or 'compile and execute on vm form' according to its module construction.
This achievement is due to the Regional Innovation Creation R&D Programs of
the Ministry of Economy, Trade and Industry of Japan.
# Features of mruby
|FIXME:
| + Simple Syntax
| + *Normal* Object-Oriented features(ex. class, method calls)
| + *Advanced* Object-Oriented features(ex. Mix-in, 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 ....
There are some other branches under development. Try the following
command and see the list of branches:
$ git ....
# mruby home-page (sorry, it's not launched yet. we're working on this)
The URL of the mruby home-page is:
http://www.mruby.org/
# Mailing list
There is a mailing list to talk about mruby.
To subscribe this list....[T.B.D.]
# How to compile and install
See the file INSTALL.
# Copying
See the file COPYING.
# About Contribution
Thank you for considering of contribution for mruby.
mruby has chosen a MIT License as comparatively loose condition,
to expect to apply into various environment such as embedded system.
However, the license requires to display copyright notice and license
sentenses, for example manual or so. Especially for the recent bigger
system, it is comlecated or very troublesome.
So, 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" with keeping copyright of you.
(We did not intend you to transfer or waive your copyright,
Actual copyright holder name, you, will be listed in 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
-------------------------------------------------------
created at: Fri Apr 20 11:57:36 JST 2012
Local variables:
mode: indented-text
end:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment