README.md

   1 <div align="center">
   2   <p>
   3     <a href="https://mruby.org/">
   4       <img src="https://avatars.githubusercontent.com/u/1796512?s=200&v=4"
   5         alt="The mruby programming language" title="mruby">
   6     </a>
   7   </p>
   8   <h1>mruby</h1>
   9   <a href="https://github.com/marketplace/actions/super-linter">
  10     <img src="https://github.com/mruby/mruby/actions/workflows/super-linter.yml/badge.svg"
  11       alt="GitHub Super-Linter">
  12   </a>
  13 </div>
  14
  15 ## What is mruby
  16
  17 mruby is the lightweight implementation of the Ruby language complying to (part
  18 of) the [ISO standard][ISO-standard] with more recent features provided by Ruby 3.x.
  19 Also, its syntax is Ruby 3.x compatible except for pattern matching.
  20
  21 You can link and embed mruby within your application. The "mruby" interpreter
  22 program and the interactive "mirb" shell are provided as examples. You can also
  23 compile Ruby programs into compiled byte code using the "mrbc" compiler. All
  24 these tools are located in the "bin" directory. "mrbc" can also generate
  25 compiled byte code in a C source file. See the "mrbtest" program under the
  26 "test" directory for an example.
  27
  28 This achievement was sponsored by the Regional Innovation Creation R&D Programs
  29 of the Ministry of Economy, Trade and Industry of Japan.
  30
  31 ## How to get mruby
  32
  33 To get mruby, you can download the stable version 3.3.0 from the official mruby
  34 GitHub repository or clone the trunk of the mruby source tree with the "git
  35 clone" command. You can also install and compile mruby using [ruby-install](https://github.com/postmodern/ruby-install), [ruby-build](https://github.com/rbenv/ruby-build) or [rvm](https://github.com/rvm/rvm).
  36
  37 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)
  38
  39 The trunk of the mruby source tree can be checked out with the
  40 following command:
  41
  42 ```console
  43 $ git clone https://github.com/mruby/mruby.git
  44 ```
  45
  46 ## mruby homepage
  47
  48 The URL of the mruby homepage is: <https://mruby.org>.
  49
  50 ## Mailing list
  51
  52 We don't have a mailing list, but you can use [GitHub issues](https://github.com/mruby/mruby/issues).
  53
  54 ## How to compile, test, and install (mruby and gems)
  55
  56 For the simplest case, type
  57
  58 ```console
  59 rake all test
  60 ```
  61
  62 See the [compile.md](doc/guides/compile.md) file for the detail.
  63
  64 ## Building documentation
  65
  66 There are two sets of documentation in mruby: the mruby API (generated by YARD) and C API (Doxygen and Graphviz)
  67
  68 To build both of them, simply go
  69
  70 ```console
  71 rake doc
  72 ```
  73
  74 You can also view them in your browser
  75
  76 ```console
  77 rake view_api
  78 rake view_capi
  79 ```
  80
  81 ## How to customize mruby (mrbgems)
  82
  83 mruby contains a package manager called "mrbgems" that you can use to create
  84 extensions in C and/or Ruby. For a guide on how to use mrbgems, consult the
  85 [mrbgems.md](doc/guides/mrbgems.md) file, and for example code, refer to the
  86 [examples/mrbgems/](examples/mrbgems) folder.
  87
  88 ## License
  89
  90 mruby is released under the [MIT License](LICENSE).
  91
  92 ## Note for License
  93
  94 mruby has chosen a MIT License due to its permissive license allowing
  95 developers to target various environments such as embedded systems.
  96 However, the license requires the display of the copyright notice and license
  97 information in manuals for instance. Doing so for big projects can be
  98 complicated or troublesome. This is why mruby has decided to display "mruby
  99 developers" as the copyright name to make it simple conventionally.
 100 In the future, mruby might ask you to distribute your new code
 101 (that you will commit,) under the MIT License as a member of
 102 "mruby developers" but contributors will keep their copyright.
 103 (We did not intend for contributors to transfer or waive their copyrights,
 104 actual copyright holder name (contributors) will be listed in the [AUTHORS](AUTHORS)
 105 file.)
 106
 107 Please ask us if you want to distribute your code under another license.
 108
 109 ## How to Contribute
 110
 111 To contribute to mruby, please refer to the [contribution guidelines][contribution-guidelines] and send a pull request to the [mruby GitHub repository](https://github.com/mruby/mruby).
 112 By contributing, you grant non-exclusive rights to your code under the MIT License.
 113
 114 [ISO-standard]: https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579
 115 [contribution-guidelines]: CONTRIBUTING.md