diff options
| author | take_cheeze <[email protected]> | 2014-06-22 22:13:28 +0900 |
|---|---|---|
| committer | take_cheeze <[email protected]> | 2014-06-22 22:15:17 +0900 |
| commit | c9df4ccf07c4fc1aa3a50483b2be6eb3d8b933e2 (patch) | |
| tree | 047ef6eaf3023cf21d000c8c5ceef628067ab43f /doc | |
| parent | c43afd68cd1334240981573e388c40168cbe4cdb (diff) | |
| download | mruby-c9df4ccf07c4fc1aa3a50483b2be6eb3d8b933e2.tar.gz mruby-c9df4ccf07c4fc1aa3a50483b2be6eb3d8b933e2.zip | |
Update documentation of `summary` property of mrbgem spec.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mrbgems/README.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/mrbgems/README.md b/doc/mrbgems/README.md index 5897c5727..a87c7c92b 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,7 +120,9 @@ 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) |