summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2014-03-12 15:12:10 +0900
committerYukihiro "Matz" Matsumoto <[email protected]>2014-03-12 15:12:10 +0900
commit1b845de755acc53ebf37821eda8e97356445d617 (patch)
tree380a0607a059528f8c3ae5b97c1b5f74294eb5cd
parentfa2e87c46816cf2258042c547e677925d86440ea (diff)
parent244260b05ed763351cf9f6e9550dc81ed8ec45d3 (diff)
downloadmruby-1b845de755acc53ebf37821eda8e97356445d617.tar.gz
mruby-1b845de755acc53ebf37821eda8e97356445d617.zip
Merge pull request #1848 from joejimbo/master
Added a short description about mruby gems
-rw-r--r--INSTALL14
-rw-r--r--README.md2
2 files changed, 15 insertions, 1 deletions
diff --git a/INSTALL b/INSTALL
index 7a0e6cd47..865ea218e 100644
--- a/INSTALL
+++ b/INSTALL
@@ -28,6 +28,20 @@ send a detailed report to the developers that includes the error log, machine,
and OS type.
+* Adding existing gems
+
+Gems from the [list of mruby gems](http://www.mruby.org/libraries/) can be added by adding
+their respective GitHub URLs to build_config.rb. For example, to add implementations of the
+File and IO Ruby core classes to mruby, insert the following in build_config.rb under the
+comment section `Use mrbgems`:
+
+ conf.gem :git => '[email protected]:iij/mruby-io.git', :branch => 'master'
+
+ Afterwards, re-run:
+
+ ruby ./minirake
+
+
* Porting to other platforms
diff --git a/README.md b/README.md
index f7633019f..fbfed5fc6 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,7 @@ The URL of the mruby home-page is:
To subscribe to the mruby mailing list....[T.B.D.]
-## How to compile and install
+## How to compile and install (mruby and gems)
See the INSTALL file.