diff options
| author | Yukihiro "Matz" Matsumoto <[email protected]> | 2020-10-31 22:25:17 +0900 |
|---|---|---|
| committer | Yukihiro "Matz" Matsumoto <[email protected]> | 2020-11-02 15:14:36 +0900 |
| commit | ddfac9aba0025f3ecb69696e12a0bf311ccd4909 (patch) | |
| tree | 397c88bcf363d2dde0fe069f7d5f9f6eefb20d53 /doc | |
| parent | 9233d28ac793f8dc7640d1ce10f9cf2822ccbce8 (diff) | |
| download | mruby-ddfac9aba0025f3ecb69696e12a0bf311ccd4909.tar.gz mruby-ddfac9aba0025f3ecb69696e12a0bf311ccd4909.zip | |
Search gem from `MRUBY_ROOT` if build config is in `build_config`.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/mrbgems.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/guides/mrbgems.md b/doc/guides/mrbgems.md index 4246587ce..f05fd1f08 100644 --- a/doc/guides/mrbgems.md +++ b/doc/guides/mrbgems.md @@ -12,12 +12,18 @@ a GEM, add the following line to your build configuration file, for example: conf.gem '/path/to/your/gem/dir' ``` -You can also use a relative path which would be relative from the mruby root: +You can also use a relative path to specify a gem. ```ruby conf.gem 'examples/mrbgems/ruby_extension_example' ``` +In that case, + +* if your build configuration file is in the `build_config` directory, it's + relative from `MRUBY_ROOT`. +* otherwise, it is relative from the directory where your build configuration is. + A remote GIT repository location for a GEM is also supported: ```ruby conf.gem :git => 'https://github.com/masuidrive/mrbgems-example.git', :branch => 'master' |