diff options
| author | Eric Hodel <[email protected]> | 2014-09-21 10:56:57 +0900 |
|---|---|---|
| committer | Eric Hodel <[email protected]> | 2014-09-21 10:59:27 +0900 |
| commit | a12d8e32b15745e7648c60d0ce181c5d8126a98a (patch) | |
| tree | a667d47559477660def1a8f025b73b478d9919ab | |
| parent | 5f7b0580b75e2fd88d886ecf181a211b9273af7c (diff) | |
| download | mruby-a12d8e32b15745e7648c60d0ce181c5d8126a98a.tar.gz mruby-a12d8e32b15745e7648c60d0ce181c5d8126a98a.zip | |
Wrap README.md to 80 columns
| -rw-r--r-- | README.md | 50 |
1 files changed, 31 insertions, 19 deletions
@@ -1,19 +1,19 @@ -[](https://travis-ci.org/mruby/mruby) +[![Build Status][build-status-img]][travis-ci] ## What's mruby -mruby is the lightweight implementation of the Ruby language complying to (part of) -the [ISO standard](http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579). -Its syntax is Ruby 1.9 compatible. +mruby is the lightweight implementation of the Ruby language complying to (part +of) the [ISO standard][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. +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. +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 @@ -48,6 +48,7 @@ To subscribe to the mruby mailing list....[T.B.D.] See the INSTALL file. + ## Running Tests To run the tests, execute the following from the project's root directory. @@ -58,12 +59,14 @@ Or $ ruby ./minirake test + ## Customization mruby contains a package manager called *mrbgems*. To create extensions in C and/or Ruby you should create a *GEM*. You will find a complete documentation with examples under *examples/mrbgems*. + ## License Copyright (c) 2014 mruby developers @@ -86,26 +89,35 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + ## 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. +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.) +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](https://github.com/mruby/mruby/blob/master/CONTRIBUTING.md) -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. +See the [contribution guidelines][contribution-guidelines] 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. + +[ISO-standard]: http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579 +[build-status-img]: https://travis-ci.org/mruby/mruby.png?branch=master +[contribution-guidelines]: https://github.com/mruby/mruby/blob/master/CONTRIBUTING.md +[travis-ci]: https://travis-ci.org/mruby/mruby + |
