diff options
| author | Yukihiro "Matz" Matsumoto <[email protected]> | 2014-06-22 22:23:20 +0900 |
|---|---|---|
| committer | Yukihiro "Matz" Matsumoto <[email protected]> | 2014-06-22 22:23:20 +0900 |
| commit | a26599b5c6f5079ffaec791da279d425a20117b1 (patch) | |
| tree | 7f841faab82c258e3c403d1b408c232d0b7058b9 | |
| parent | c43afd68cd1334240981573e388c40168cbe4cdb (diff) | |
| parent | ad74bf6d0b47cd4bea87f4a4067f93deca526eb9 (diff) | |
| download | mruby-a26599b5c6f5079ffaec791da279d425a20117b1.tar.gz mruby-a26599b5c6f5079ffaec791da279d425a20117b1.zip | |
Merge pull request #2413 from take-cheeze/summary_doc
Update documentation of `summary` property of mrbgem spec.
| -rw-r--r-- | doc/mrbgems/README.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/mrbgems/README.md b/doc/mrbgems/README.md index 5897c5727..040687333 100644 --- a/doc/mrbgems/README.md +++ b/doc/mrbgems/README.md @@ -105,6 +105,7 @@ GEM directory. A typical GEM specification could look like this for example: MRuby::Gem::Specification.new('c_and_ruby_extension_example') do |spec| spec.license = 'MIT' spec.author = 'mruby developers' + spec.summary = 'Example mrbgem using C and ruby' end ``` @@ -119,11 +120,13 @@ information purpose: * `spec.author` or `spec.authors` (Developer name or a list of them) * `spec.version` (Current version) * `spec.description` (Detailed description) -* `spec.summary` (Short summary) +* `spec.summary` + * One line short description of mrbgem. + * Printed in build summary of rake when set. * `spec.homepage` (Homepage) * `spec.requirements` (External requirements as information for user) -The license and author properties are required in every GEM! +The `license` and `author` properties are required in every GEM! In case your GEM is depending on other GEMs please use `spec.add_dependency(gem, *requirements[, default_get_info])` like: |