Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated the English README to fix some minor grammatical and spelling…

… mistakes
  • Loading branch information...
commit 754ab1b0c99cb7bc07fa45fa8bb4f4448dd50351 1 parent 1af5ac0
Matt Aimonetti authored
Showing with 26 additions and 27 deletions.
  1. +26 −27 README.md
53 README.md
View
@@ -1,17 +1,17 @@
# !!Notice!!
- This is a preliminary release for internal team reviewing.
- The URL and address discribed below are not available yet.
- The official release will be announced later. Thanks.
- Any suggestion of the modification are welcome,
- but the response might be delayed. Sorry for that in advance.
+ This is a preliminary release for internal team review.
+ The URLs and addresses discribed below are not available yet.
+ The official release will be announced later.
+ Any suggestion for modification is welcome.
+ Delays in replies are to be expected. Sorry in advance.
## What's mruby
-mruby is the light-weight implementation of the Ruby language complied to
-the ISO standard to execute various environments. It can run in 'interpreter
-form' or 'compile and execute on vm form' according to its module construction.
+mruby is the lightweight implementation of the Ruby language complying to
+the [ISO standard](http://www.ipa.go.jp/about/press/20120402_2.html).
+mruby can run Ruby code in 'interpreter mode' or 'compile and execute it on a virtual machine' depending on how the developer's preference.
-This achievement is due to the Regional Innovation Creation R&D Programs of
+This achievement was sponsored by the Regional Innovation Creation R&D Programs of
the Ministry of Economy, Trade and Industry of Japan.
@@ -22,7 +22,7 @@ the Ministry of Economy, Trade and Industry of Japan.
|FIXME:
| + Simple Syntax
| + *Normal* Object-Oriented features(ex. class, method calls)
- | + *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
+ | + *Advanced* Object-Oriented features(ex. Mixin, Singleton-method)
| + Operator Overloading
| + Exception Handling
| + Iterators and Closures
@@ -42,7 +42,7 @@ The mruby distribution files can be found in the following site:
The trunk of the mruby source tree can be checked out with the
following command:
- $ git ....
+ $ git clone https://github.com/mruby/mruby.git
There are some other branches under development. Try the following
command and see the list of branches:
@@ -52,44 +52,43 @@ command and see the list of branches:
## mruby home-page
-(sorry, it's not launched yet. we're working on this)
+mruby's website is not launched yet but we are actively working on it.
-The URL of the mruby home-page is:
+The URL of the mruby home-page will be:
http://www.mruby.org/
## Mailing list
-There is a mailing list to talk about mruby.
-To subscribe this list....[T.B.D.]
+To subscribe the mruby mailing list....[T.B.D.]
## How to compile and install
-See the file INSTALL.
+See the INSTALL file.
## Copying
-See the file COPYING.
+See the COPYING file.
## About Contribution
-Thank you for considering of contribution for mruby.
-mruby has chosen a MIT License as comparatively loose condition,
-to expect to apply into various environment such as embedded system.
-However, the license requires to display copyright notice and license
-sentenses, for example manual or so. Especially for the recent bigger
-system, it is comlecated or very troublesome.
-So, mruby has decided to display "mruby developers" as copyright name
+Thank you for considering contributing to mruby.
+mruby has chosen a MIT License due to its permissive license allowing
+developer to target various environments such as embedded systems.
+However, the license requires to display 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 copyright name
to make it simple conventionally.
In the future, mruby might ask you to distribute your new codes
(that you will commit,) under MIT License as a member of
-"mruby developers" with keeping copyright of you.
-(We did not intend you to transfer or waive your copyright,
- Actual copyright holder name, you, will be listed in AUTHORS file.)
+"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 other license
or if your code is derived from GPL code.
Please sign in to comment.
Something went wrong with that request. Please try again.