Commit 1854941f authored by Yukihiro "Matz" Matsumoto's avatar Yukihiro "Matz" Matsumoto

Merge pull request #1271 from carsonmcdonald/mrbgemdocfixes

Minor wording changes and a couple spelling fixes
parents 5c6d2818 43732ecd
...@@ -29,10 +29,10 @@ NOTE: `:bitbucket` option supports only git. Hg is unsupported in this version. ...@@ -29,10 +29,10 @@ NOTE: `:bitbucket` option supports only git. Hg is unsupported in this version.
## GemBox ## GemBox
There are instances when you wish to add a collection of gems into mruby at There are instances when you wish to add a collection of mrbgems into mruby at
once, or be able to substitute gems based on configuration, without having to once, or be able to substitute mrbgems based on configuration, without having to
add each gem to the *build_config.rb* file. A packaged collection of mrbgems add each gem to the *build_config.rb* file. A packaged collection of mrbgems
is called a GemBox. A GemBox is a file that contains a list of gems to load is called a GemBox. A GemBox is a file that contains a list of mrbgems to load
into mruby, in the same format as if you were adding them to *build_config.rb* into mruby, in the same format as if you were adding them to *build_config.rb*
via `config.gem`, but wrapped in an `MRuby::GemBox` object. GemBoxes are via `config.gem`, but wrapped in an `MRuby::GemBox` object. GemBoxes are
loaded into mruby via `config.gembox 'boxname'`. loaded into mruby via `config.gembox 'boxname'`.
...@@ -86,8 +86,8 @@ of your GEM. ...@@ -86,8 +86,8 @@ of your GEM.
## Build process ## Build process
mrbgems expects a specifcation file called *mrbgem.rake* inside of your mrbgems expects a specification file called *mrbgem.rake* inside of your
GEM direcotry. A typical GEM specification could look like this for example: GEM directory. A typical GEM specification could look like this for example:
MRuby::Gem::Specification.new('c_and_ruby_extension_example') do |spec| MRuby::Gem::Specification.new('c_and_ruby_extension_example') do |spec|
spec.license = 'MIT' spec.license = 'MIT'
...@@ -95,8 +95,8 @@ GEM direcotry. A typical GEM specification could look like this for example: ...@@ -95,8 +95,8 @@ GEM direcotry. A typical GEM specification could look like this for example:
end end
The mrbgems build process will use this specification to compile Object and Ruby The mrbgems build process will use this specification to compile Object and Ruby
files. The compilation results will be add to *lib/libmruby.a*. This file is used files. The compilation results will be added to *lib/libmruby.a*. This file exposes
by tools like `mruby` and `mirb` to empower the GEM functionality. the GEM functionality to tools like `mruby` and `mirb`.
The following properties can be set inside of your `MRuby::Gem::Specification` for The following properties can be set inside of your `MRuby::Gem::Specification` for
information purpose: information purpose:
...@@ -109,7 +109,7 @@ information purpose: ...@@ -109,7 +109,7 @@ information purpose:
* `spec.homepage` (Homepage) * `spec.homepage` (Homepage)
* `spec.requirements` (External requirements as information for user) * `spec.requirements` (External requirements as information for user)
It is required for every GEM to have a license and an author! The license and author properties are required in every GEM!
In case your GEM is depending on other GEMs please use In case your GEM is depending on other GEMs please use
`spec.add_dependency(gem, *requirements)` like: `spec.add_dependency(gem, *requirements)` like:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment