summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2020-05-02 09:06:28 +0900
committerYukihiro "Matz" Matsumoto <[email protected]>2020-10-12 16:20:48 +0900
commit10b1a52bb88ac3a7443c91fd866f8724169a2586 (patch)
tree333d8c7e79522e046c0c8037dea27fb5e224a0ae /README.md
parentdcfc2dbf148cd533ed5419efde31822c38bcdaf5 (diff)
downloadmruby-10b1a52bb88ac3a7443c91fd866f8724169a2586.tar.gz
mruby-10b1a52bb88ac3a7443c91fd866f8724169a2586.zip
Small updates on documents:
- README.md - CONTRIBUTING.md - doc/limitations.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 5bea9d442..f7db82375 100644
--- a/README.md
+++ b/README.md
@@ -40,11 +40,13 @@ We don't have a mailing list, but you can use [GitHub issues](https://github.com
See the [compile.md](https://github.com/mruby/mruby/blob/master/doc/guides/compile.md) file.
-## Running Tests
+## How to Build
-To run the tests, execute the following from the project's root directory.
+To build mruby, execute the following from the project's root directory.
- $ rake test
+ $ rake TARGET=<target> test
+
+The default `TARGET` is `host`. `TARGET` will be loaded from `target` directory.
Note: `bison` bundled with MacOS is too old to compile `mruby`.
Try `brew install bison` and follow the instuction shown to update