From c9df4ccf07c4fc1aa3a50483b2be6eb3d8b933e2 Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Sun, 22 Jun 2014 22:13:28 +0900 Subject: Update documentation of `summary` property of mrbgem spec. --- doc/mrbgems/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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) -- cgit v1.2.3 From ad74bf6d0b47cd4bea87f4a4067f93deca526eb9 Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Sun, 22 Jun 2014 22:15:40 +0900 Subject: Quote required mrbgem spec property. --- doc/mrbgems/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/mrbgems/README.md b/doc/mrbgems/README.md index a87c7c92b..040687333 100644 --- a/doc/mrbgems/README.md +++ b/doc/mrbgems/README.md @@ -126,7 +126,7 @@ information purpose: * `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: -- cgit v1.2.3