summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDaniel Bovensiepen <[email protected]>2013-05-02 13:50:45 +0800
committerDaniel Bovensiepen <[email protected]>2013-05-02 13:50:45 +0800
commit823dc380aa834efb34e461305480834c38c9c0ea (patch)
treeab45fc388a16b844c85bfa4bf8e268dd7530aa1b
parentbb7d404e64e155f2c3c966c6ad621ba5b78dbb09 (diff)
downloadmruby-823dc380aa834efb34e461305480834c38c9c0ea.tar.gz
mruby-823dc380aa834efb34e461305480834c38c9c0ea.zip
Improve mrbgems documentation
-rw-r--r--doc/mrbgems/README.md44
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/mrbgems/README.md b/doc/mrbgems/README.md
index 5b43ccff2..046717f8c 100644
--- a/doc/mrbgems/README.md
+++ b/doc/mrbgems/README.md
@@ -101,13 +101,13 @@ by tools like `mruby` and `mirb` to empower the GEM functionality.
The following properties can be set inside of your `MRuby::Gem::Specification` for
information purpose:
-* spec.license or spec.licenses (License [String] or Licenses [Array] for this GEM)
-* spec.author or spec.authors (Developer names author [String] authors [Array])
-* spec.version (Current Version [String]
-* spec.description (Detailed description [String])
-* spec.summary (Short summary [String])
-* spec.homepage (Homepage [String])
-* spec.requirements
+* `spec.license` or `spec.licenses` (A single license or a list of them under which this GEM is licensed)
+* `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.homepage` (Homepage)
+* `spec.requirements` (External requirements as information for user)
It is required for every GEM to have a license and an author!
@@ -118,30 +118,30 @@ In case your GEM is depending on other GEMs please use
spec.license = 'MIT'
spec.authors = 'mruby developers'
- # add GEM dependency parser.
- # Version has to be between 1.0.0 and 1.5.2
- spec.add_dependency('parser', '> 1.0.0', '< 1.5.2')
+ # add GEM dependency mruby-parser.
+ # Version has to be between 1.0.0 and 1.5.2
+ spec.add_dependency('mruby-parser', '> 1.0.0', '< 1.5.2')
end
The usage of versions is optional.
-__ATTENTION__
+__ATTENTION:__
The dependency system is currently (May 2013) under development and doesn't check
-or resolve dependencies for now!
+or resolve dependencies!
In case your GEM has more complex build requirements you can use
the following options additionally inside of your GEM specification:
-* spec.cflags (C compiler flags for this GEM)
-* spec.mruby_cflags (global C compiler flags for everything)
-* spec.mruby_ldflags (global linker flags for everything)
-* spec.mruby_libs (global libraries for everything)
-* spec.mruby_includes (global includes for everything)
-* spec.rbfiles (Ruby files to compile)
-* spec.objs (Object files to compile)
-* spec.test_rbfiles (Ruby test files for integration into mrbtest)
-* spec.test_objs (Object test files for integration into mrbtest)
-* spec.test_preload (Initialization files for mrbtest)
+* `spec.cflags` (C compiler flags)
+* `spec.mruby_cflags` (global C compiler flags for everything)
+* `spec.mruby_ldflags` (global linker flags for everything)
+* `spec.mruby_libs` (global libraries for everything)
+* `spec.mruby_includes` (global includes for everything)
+* `spec.rbfiles` (Ruby files to compile)
+* `spec.objs` (Object files to compile)
+* `spec.test_rbfiles` (Ruby test files for integration into mrbtest)
+* `spec.test_objs` (Object test files for integration into mrbtest)
+* `spec.test_preload` (Initialization files for mrbtest)
## C Extension