diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 14 insertions, 5 deletions
@@ -1,4 +1,7 @@ +# mruby + [![Build Status][build-status-img]][travis-ci] +[](https://github.com/marketplace/actions/super-linter) ## What is mruby @@ -24,13 +27,15 @@ The latest development version of mruby can be downloaded via the following URL: The trunk of the mruby source tree can be checked out with the following command: - $ git clone https://github.com/mruby/mruby.git +``` +$ 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 home-page -The URL of the mruby home-page is: https://mruby.org. +The URL of the mruby home-page is: <https://mruby.org>. ## Mailing list @@ -46,12 +51,16 @@ There are two sets of documentation in mruby: the mruby API (generated by yard) To build both of them, simply go - rake doc +``` +rake doc +``` You can also view them in your browser - rake view_api - rake view_capi +``` +rake view_api +rake view_capi +``` ## How to customize mruby (mrbgems) |