summaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
authorHidetaka Takano <[email protected]>2012-04-20 17:46:01 +0900
committerHidetaka Takano <[email protected]>2012-04-20 17:46:08 +0900
commitdbb4790c170830ec3a28b68140b07af0c53f6737 (patch)
treeea5ccc6fdacf13448fd8f3fcaad11bcfd21ea59c /README
parent34e376e05d95b06e0e074a0712c2fe9df8b3e551 (diff)
downloadmruby-dbb4790c170830ec3a28b68140b07af0c53f6737.tar.gz
mruby-dbb4790c170830ec3a28b68140b07af0c53f6737.zip
add: markdown README
Diffstat (limited to 'README')
-rw-r--r--README48
1 files changed, 25 insertions, 23 deletions
diff --git a/README b/README
index e9a7523d4..12f8f5135 100644
--- a/README
+++ b/README
@@ -1,14 +1,15 @@
-!!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.
+!!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.
* 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 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.
This achievement is due to the Regional Innovation Creation R&D Programs of
the Ministry of Economy, Trade and Industry of Japan.
@@ -16,18 +17,18 @@ the Ministry of Economy, Trade and Industry of Japan.
* Features of mruby
-|FIXME:
-| + Simple Syntax
-| + *Normal* Object-Oriented features(ex. class, method calls)
-| + *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
-| + Operator Overloading
-| + Exception Handling
-| + Iterators and Closures
-| + Garbage Collection
-| + Dynamic Loading of Object files(on some architecture)
-| + Highly Portable (works on many Unix-like/POSIX compatible platforms
-| as well as Windows, Mac OS X, BeOS etc.)
-| cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms
+ |FIXME:
+ | + Simple Syntax
+ | + *Normal* Object-Oriented features(ex. class, method calls)
+ | + *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
+ | + Operator Overloading
+ | + Exception Handling
+ | + Iterators and Closures
+ | + Garbage Collection
+ | + Dynamic Loading of Object files(on some architecture)
+ | + Highly Portable (works on many Unix-like/POSIX compatible platforms
+ | as well as Windows, Mac OS X, BeOS etc.)
+ | cf. http://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms
* How to get mruby
@@ -39,19 +40,19 @@ 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 ....
There are some other branches under development. Try the following
command and see the list of branches:
- $ git ....
+ $ git ....
* mruby home-page (sorry, it's not launched yet. we're working on this)
The URL of the mruby home-page is:
- http://www.mruby.org/
+ http://www.mruby.org/
* Mailing list
@@ -59,6 +60,7 @@ The URL of the mruby home-page is:
There is a mailing list to talk about mruby.
To subscribe this list....[T.B.D.]
+
* How to compile and install
See the file INSTALL.