Repository files navigation

mruby

mruby is the lightweight implementation of the Ruby language complying to (partof) theISO standard with more recent features provided by Ruby 3.x.Also, its syntax is Ruby 3.x compatible except for pattern matching.

You can link and embed mruby within your application. The "mruby" interpreterprogram and the interactive "mirb" shell are provided as examples. You can alsocompile Ruby programs into compiled byte code using the "mrbc" compiler. Allthese tools are located in the "bin" directory. "mrbc" can also generatecompiled 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 Programsof the Ministry of Economy, Trade and Industry of Japan.

To get mruby, you can download the stable version 3.3.0 from the official mrubyGitHub repository or clone the trunk of the mruby source tree with the "gitclone" command. You can also install and compile mruby usingruby-install,ruby-build orrvm.

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 thefollowing command:

$git clone https://github.com/mruby/mruby.git

The URL of the mruby homepage is:https://mruby.org.

We don't have a mailing list, but you can useGitHub issues.

For the simplest case, type

rake all test

See thecompile.md file for the detail.

There are two sets of documentation in mruby: the mruby API (generated by YARD) and C API (Doxygen and Graphviz)

To build both of them, simply go

rake doc

You can also view them in your browser

rake view_apirake view_capi

mruby contains a package manager called "mrbgems" that you can use to createextensions in C and/or Ruby. For a guide on how to use mrbgems, consult themrbgems.md file, and for example code, refer to theexamples/mrbgems/ folder.

• About the Limitations of mruby
• About the Compile
• About the Debugger with themrdb Command
• About GC Arena
• About the mruby directory structure
• About Linking withlibmruby
• About Memory Allocator Customization
• About Build-time Configurations
• About the Build-time Library Manager
• About the Symbols
• Internal Implementation / About Value Boxing
• Internal Implementation / About mruby Virtual Machine Instructions

mruby is released under theMIT License.

mruby has chosen a MIT License due to its permissive license allowingdevelopers to target various environments such as embedded systems.However, the license requires the display of the copyright notice and licenseinformation in manuals for instance. Doing so for big projects can becomplicated or troublesome. This is why mruby has decided to display "mrubydevelopers" 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 theAUTHORSfile.)

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

To contribute to mruby, please refer to thecontribution guidelines and send a pull request to themruby GitHub repository.By contributing, you grant non-exclusive rights to your code under the MIT License.