diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 7 insertions, 11 deletions
@@ -6,7 +6,7 @@ mruby is the lightweight implementation of the Ruby language complying to (part of) the [ISO standard][ISO-standard]. Its syntax is Ruby 2.x compatible. mruby can be linked and embedded within your application. We provide the -interpreter program "mruby" and the interactive mruby shell "mirb" as examples. +interpreter program "mruby", and the interactive mruby shell "mirb" as examples. You can also compile Ruby programs into compiled byte code using the mruby compiler "mrbc". All those tools reside in the "bin" directory. "mrbc" is also able to generate compiled byte code in a C source file, see the "mrbtest" @@ -17,9 +17,7 @@ of the Ministry of Economy, Trade and Industry of Japan. ## How to get mruby -The preview version 3.0.0 of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/archive/3.0.0-preview.zip](https://github.com/mruby/mruby/archive/3.0.0-preview.zip) - -The stable version 2.1.2 of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/archive/2.1.2.zip](https://github.com/mruby/mruby/archive/2.1.2.zip) +The stable version 3.0.0 of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/archive/3.0.0.zip](https://github.com/mruby/mruby/archive/3.0.0.zip) The latest development version of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/zipball/master](https://github.com/mruby/mruby/zipball/master) @@ -40,7 +38,7 @@ We don't have a mailing list, but you can use [GitHub issues](https://github.com ## How to compile, test, and install (mruby and gems) -See the [compile.md](https://github.com/mruby/mruby/blob/master/doc/guides/compile.md) file. +See the [compile.md](doc/guides/compile.md) file. ## Building documentation @@ -59,12 +57,12 @@ You can also view them in your browser mruby contains a package manager called *mrbgems*. To create extensions in C and/or Ruby you should create a *GEM*. For a documentation of how to -use mrbgems consult the file [mrbgems.md](https://github.com/mruby/mruby/blob/master/doc/guides/mrbgems.md). +use mrbgems consult the file [mrbgems.md](doc/guides/mrbgems.md). For example code of how to use mrbgems look into the folder *examples/mrbgems/*. ## License -mruby is released under the [MIT License](https://github.com/mruby/mruby/blob/master/LICENSE). +mruby is released under the [MIT License](LICENSE). ## Note for License @@ -78,7 +76,7 @@ In the future, mruby might ask you to distribute your new code (that you will commit,) under the 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 +Actual copyright holder name (contributors) will be listed in the [AUTHORS.md](AUTHORS.md) file.) Please ask us if you want to distribute your code under another license. @@ -87,9 +85,7 @@ Please ask us if you want to distribute your code under another license. See the [contribution guidelines][contribution-guidelines], and then send a pull request to <https://github.com/mruby/mruby>. We consider you have granted -non-exclusive right to your contributed code under MIT license. If you want to -be named as one of mruby developers, please include an update to the AUTHORS -file in your pull request. +non-exclusive right to your contributed code under MIT license. [ISO-standard]: https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579 [build-status-img]: https://travis-ci.org/mruby/mruby.svg?branch=master |