Skip to content

M
mruby
Commit c9df4ccf authored by take_cheeze's avatar take_cheeze
Browse files
Options

Update documentation of `summary` property of mrbgem spec.

parent c43afd68
Show whitespace changes
Inline Side-by-side
Showing with 4 additions and 1 deletion
doc/mrbgems/README.md
View file @ c9df4ccf
...@@ -105,6 +105,7 @@ GEM directory. A typical GEM specification could look like this for example: ...@@ -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| MRuby::Gem::Specification.new('c_and_ruby_extension_example') do |spec|
spec.license = 'MIT' spec.license = 'MIT'
spec.author = 'mruby developers' spec.author = 'mruby developers'
spec.summary = 'Example mrbgem using C and ruby'
end end
``` ```
...@@ -119,7 +120,9 @@ information purpose: ...@@ -119,7 +120,9 @@ information purpose:
* `spec.author` or `spec.authors` (Developer name or a list of them) * `spec.author` or `spec.authors` (Developer name or a list of them)
* `spec.version` (Current version) * `spec.version` (Current version)
* `spec.description` (Detailed description) * `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.homepage` (Homepage)
* `spec.requirements` (External requirements as information for user) * `spec.requirements` (External requirements as information for user)
......
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