Lightweight Ruby
C Ruby Yacc C++ Batchfile Shell
Switch branches/tags
Nothing to show
Permalink
Failed to load latest commit information.
benchmark Remove benchmarks not in mruby Apr 24, 2015
bin add mruby sources Apr 20, 2012
doc Reorganize C++ exceptions; ref #3470 Mar 2, 2017
examples Added example build script for Android armeabi-v7a NEON hardware FPU Feb 16, 2017
include Keep reference to mrb_context from env; fix #3619 Apr 22, 2017
lib/mruby Change to Proc.new to make Ruby 1.9 Happy Sep 7, 2015
mrbgems Avoid use of `snprintf()` when DISABLE_STDIO is set; fix #3632 Apr 25, 2017
mrblib Fix result if pattern is empty Mar 22, 2017
src Avoid use of `snprintf()` when DISABLE_STDIO is set; fix #3632 Apr 25, 2017
tasks Add --libmruby-path support to mruby-bin-mruby-config. Apr 22, 2017
test Update NODE_XSTR, NODE_DSXTR tests; ref #3605 Apr 12, 2017
.gitignore Ignore file generated by ctags Mar 26, 2017
.gitlab-ci.yml Gitlab tests for multiple configurations Feb 16, 2017
.travis.yml Remove webhook notification for Travis CI Nov 17, 2016
.yardopts Improved mrb_args_format table Oct 20, 2015
AUTHORS Update AUTHORS Nov 24, 2016
CONTRIBUTING.md Fix typos in documentation and error messages [skip ci] Jun 19, 2015
LEGAL Change mruby-random License to MIT Apr 8, 2013
MITL Update Copyright to 2017 Jan 6, 2017
Makefile remove trailing spaces Apr 30, 2014
NEWS add document Apr 20, 2012
README.md Small grammar fix Jan 20, 2016
Rakefile Gitlab tests for multiple configurations Feb 16, 2017
TODO update TODO entries; close #2831 Nov 16, 2015
appveyor.yml Change AppVeyor's clone_depth Apr 3, 2017
appveyor_config.rb Create appveyor_config.rb Mar 15, 2016
build_config.rb Update example lines of mrbgems in build_config.rb; ref #3414 Jan 25, 2017
minirake MiniRake::Task#timestamp should use Time.now only Mar 17, 2017
mruby-source.gemspec Switch gem API to constants only Sep 6, 2015
travis_config.rb Enable full-debug build on travis using `MRB_ENABLE_DEBUG_HOOK` Nov 17, 2015

README.md

Build Status

What is 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.2.0 of mruby can be downloaded via the following URL: https://github.com/mruby/mruby/archive/1.2.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

You can also install and compile mruby using ruby-install, ruby-build or rvm.

mruby home-page

The URL of the mruby home-page is: http://www.mruby.org.

Mailing list

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

How to compile and install (mruby and gems)

See the doc/guides/compile.md file.

Running Tests

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

$ make test

Or

$ ruby ./minirake test

How to customize mruby (mrbgems)

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 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.

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, and 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.