mirror of
https://github.com/mruby/mruby
synced 2026-06-08 16:11:16 +00:00
README.md: update English description (used ChatGPT)
This commit is contained in:
@@ -18,18 +18,22 @@ mruby is the lightweight implementation of the Ruby language complying to (part
|
||||
of) the [ISO standard][ISO-standard] with more recent features provided by Ruby 3.x.
|
||||
Also, its syntax is Ruby 3.x compatible except for pattern matching.
|
||||
|
||||
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.
|
||||
You can link and embed mruby within your application. The "mruby" interpreter
|
||||
program and the interactive "mirb" shell are provided as examples. You can also
|
||||
compile Ruby programs into compiled byte code using the "mrbc" compiler. All
|
||||
these tools are located in the "bin" directory. "mrbc" can also 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
|
||||
|
||||
To get mruby, you can download the stable version 3.2.0 from the official mruby
|
||||
GitHub repository or clone the trunk of the mruby source tree with the "git
|
||||
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).
|
||||
|
||||
The stable version 3.2.0 of mruby can be downloaded via the following URL: [https://github.com/mruby/mruby/archive/3.2.0.zip](https://github.com/mruby/mruby/archive/3.2.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)
|
||||
@@ -41,8 +45,6 @@ following command:
|
||||
$ git clone https://github.com/mruby/mruby.git
|
||||
```
|
||||
|
||||
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).
|
||||
|
||||
## mruby homepage
|
||||
|
||||
The URL of the mruby homepage is: <https://mruby.org>.
|
||||
@@ -80,10 +82,10 @@ rake view_capi
|
||||
|
||||
## 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 [mrbgems.md](doc/guides/mrbgems.md).
|
||||
For example code of how to use mrbgems look into the [examples/mrbgems/](examples/mrbgems) directory.
|
||||
mruby contains a package manager called "mrbgems" that you can use to create
|
||||
extensions in C and/or Ruby. For a guide on how to use mrbgems, consult the
|
||||
[mrbgems.md](doc/guides/mrbgems.md) file, and for example code, refer to the
|
||||
[examples/mrbgems/](examples/mrbgems) folder.
|
||||
|
||||
## License
|
||||
|
||||
@@ -108,9 +110,8 @@ Please ask us if you want to distribute your code under another license.
|
||||
|
||||
## How to Contribute
|
||||
|
||||
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.
|
||||
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).
|
||||
By contributing, you grant non-exclusive rights to your code under the MIT License.
|
||||
|
||||
[ISO-standard]: https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579
|
||||
[contribution-guidelines]: https://github.com/mruby/mruby/blob/master/CONTRIBUTING.md
|
||||
|
||||
Reference in New Issue
Block a user