diff options
| -rw-r--r-- | README | 48 | ||||
| -rw-r--r-- | README.md | 108 |
2 files changed, 133 insertions, 23 deletions
@@ -1,14 +1,15 @@ -!!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. +!!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. +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. @@ -16,18 +17,18 @@ 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 + |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 @@ -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 following command: - $ git .... + $ git .... There are some other branches under development. Try the following command and see the list of branches: - $ git .... + $ 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/ + http://www.mruby.org/ * Mailing list @@ -59,6 +60,7 @@ The URL of the mruby home-page is: 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. diff --git a/README.md b/README.md new file mode 100644 index 000000000..a551c735b --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +# !!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: + + +------------------------------------------------------- +created at: Fri Apr 20 11:57:36 JST 2012 +Local variables: +mode: indented-text +end: |