Skip to content
This repository

Lightweight Ruby

branch: master

Symbol#to_proc to support block call.

based on a patch from @ksss; close #2071
latest commit 1d51d1a0b5
Yukihiro "Matz" Matsumoto matz authored April 17, 2014
Octocat-spinner-32 benchmark Reset the so-render benchmark so that it is what it was before my att… July 21, 2013
Octocat-spinner-32 bin add mruby sources April 20, 2012
Octocat-spinner-32 doc merge @mattn's win-compatibility April 15, 2014
Octocat-spinner-32 examples Fix build_config.rb for ArduinoDue April 08, 2014
Octocat-spinner-32 include Move src/re.h to include/mruby/re.h . April 16, 2014
Octocat-spinner-32 mrbgems Symbol#to_proc to support block call. April 17, 2014
Octocat-spinner-32 mrblib retrieve values in Hash#each to handle modified keys April 12, 2014
Octocat-spinner-32 src Merge pull request #2069 from cremno/static April 17, 2014
Octocat-spinner-32 tasks Make bintest enabling like other `enable_xxx` methods. April 09, 2014
Octocat-spinner-32 test Merge pull request #2018 from akuroda/pr_false_test April 06, 2014
Octocat-spinner-32 tools wrap function prototype by extern "C" March 02, 2014
Octocat-spinner-32 .gitignore ignore *.pdb March 07, 2014
Octocat-spinner-32 .travis.yml Update mruby-head installed on Travis CI April 04, 2014
Octocat-spinner-32 AUTHORS Please add me to the author. March 01, 2014
Octocat-spinner-32 CONTRIBUTING.md Fix styleguide based on @cremno's input March 01, 2013
Octocat-spinner-32 ChangeLog add document April 20, 2012
Octocat-spinner-32 INSTALL Added a short description on how to add mruby gems to the compilation… March 11, 2014
Octocat-spinner-32 LEGAL Change mruby-random License to MIT April 08, 2013
Octocat-spinner-32 MITL Happy new year! (update copyright year) January 30, 2014
Octocat-spinner-32 Makefile .PHONY should be placed after `all' March 07, 2014
Octocat-spinner-32 NEWS add document April 20, 2012
Octocat-spinner-32 README.md mention 1.9 compatibility in README.md; close #2031 April 09, 2014
Octocat-spinner-32 Rakefile should build "all" before "test"; close #1774 March 01, 2014
Octocat-spinner-32 TODO Remove things that look done. April 21, 2013
Octocat-spinner-32 build_config.rb Make bintest enabling like other `enable_xxx` methods. April 09, 2014
Octocat-spinner-32 minirake Add -C (--directory) option to minirake. March 30, 2014
Octocat-spinner-32 travis_config.rb disable fragile bintest on travis-ci April 13, 2014
README.md

Build Status

What's mruby

mruby is the lightweight implementation of the Ruby language complying to (part of) the ISO standard. Its syntax is Ruby 1.9 compatible.

mruby can be linked and embedded within your application. We provide the 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" program under the "test" directory for an example.

This achievement was sponsored by the Regional Innovation Creation R&D Programs of the Ministry of Economy, Trade and Industry of Japan.

How to get mruby

The stable version 1.0.0 of mruby can be downloaded via the following URL:

https://github.com/mruby/mruby/archive/1.0.0.zip

The latest development version of mruby can be downloaded via the following URL:

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

mruby home-page

The URL of the mruby home-page is:

http://www.mruby.org/

Mailing list

To subscribe to the mruby mailing list....[T.B.D.]

How to compile and install (mruby and gems)

See the INSTALL file.

Running Tests

To run the tests, execute the following from the project's root directory.

$ make test

Or

$ ruby ./minirake test

Customization

mruby contains a package manager called mrbgems. To create extensions in C and/or Ruby you should create a GEM. You will find a complete documentation with examples under examples/mrbgems.

License

Copyright (c) 2014 mruby developers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Note for License

mruby has chosen a MIT License due to its permissive license allowing developers to target various environments such as embedded systems. However, the license requires the display of 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 the copyright name to make it simple conventionally. 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 file.)

Please ask us if you want to distribute your code under another license.

How to Contribute

See the contribution guidelines then send a pull request to http://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.

Something went wrong with that request. Please try again.