README.md in ore-0.10.0 vs README.md in ore-0.11.0

- old
+ new

@@ -5,71 +5,101 @@ * [Documentation](http://rubydoc.info/gems/ore/frames) * [Email](mailto:postmodern.mod3 at gmail.com) ## Description -Ore is a flexible Ruby project generator. Unlike other Ruby project -generators, Ore provides many builtin templates and allows custom -templates to be installed from Git repositories. +Ore is a fully configurable and customisable Ruby gem generator. With Ore, you +spend less time editing files and more time writing code. ## Features ### SCMs -Ore supports generating [Git][git], [Mercurial][hg] and [SubVersion][svn] -enabled projects. +Ore supports generating [Git][git] (default), [Mercurial][hg] and using +[SubVersion][svn] repositories: $ mine my-project [--git | --hg] -### Gemspec +### Licenses -Ore generates a pure-Ruby gemspec by default. Ore can also generate a -[gemspec.yml] file. +Ore supports generating MIT (default), BSD, Apache 2.0, GPLv3 or LGPLv3 +licenses: -### Tasks + $ mine my-project [--mit | --bsd | --apache | --gpl | --lgpl] -Ore supports generating projects using [Gem::Tasks][rubygems_tasks], -[Bundler::GemHelper][bundler] and even [Gem::PackageTask][gem_package_task]. +### Testing - $ mine my-project [--rubygems-tasks | --bundler-tasks | --gem-package-task] +Ore supports generating [RSpec][rspec] (default), [Minitest][minitest] or +[Test::Unit][test_unit] tests: -### Bundler + $ mine my-project [--test-unit | --minitest | --rspec] -Ore can also generate a [Bundler][bundler] project. +### TravisCI - $ mine my-project --bundler +Ore also supports generating a [`.travis.yml`][travis.yml] file and README +badge: -### Markup + $ mine my-project --travis -Ore supports [RDoc][rdoc], [Markdown][markdown] and [Textile][textile] markup. +### Code Climate - $ mine my-project [--rdoc | --markdown | --textile] +Ore also supports adds Code Climate GPA badges: + $ mine my-project --code-climate + ### Documentation -Ore supports generating projects with [RDoc][rdoc] or [YARD][yard] -documentation. +Ore supports generating projects with [RDoc][rdoc] (default) or [YARD][yard] +documentation: $ mine my-project [--rdoc | --yard] -### Testing +Ore also supports [Markdown][markdown] (default), [Textile][textile] and +[RDoc][rdoc] markups: -Ore supports generating [RSpec][rspec], [MiniTest][mini_test] or -[Test::Unit][test_unit] tests. + $ mine my-project --yard [--rdoc | --markdown | --textile] - $ mine my-project [--test-unit | --mini-test | --rspec] +### Bundler +Ore supports [Bundler][bundler] by default. If you do not need bundler, you may +disable it: + + $ mine my-project --no-bundler + +### Gem Tasks + +Ore supports generating `Rakefile`s using [rubygems/tasks][rubygems_tasks] +(default), [bundler/gem_tasks][bundler] or even +[Gem::PackageTask][gem_package_task]: + + $ mine my-project [--rubygems-tasks | --bundler-tasks | --gem-package-task] + +### Gemspecs + +Ore generates a minimal pure-Ruby gemspec by default: + + $ mine my-project + +Ore also supports generating a [gemspec.yml] file: + + $ mine my-project --gemspec-yml + +Gemspec files support listing files from Git, Hg and SubVersion. If the project +uses Git submodules, the gemspecs will automatically include files from the +submodules. + ### Custom Templates Additional templates can also be installed from Git: $ ore install git://github.com/ruby-ore/rbenv.git $ mine my-project --rbenv ## Requirements -* [thor](https://github.com/wycats/thor#readme) ~> 0.15 +* [ruby] >= 1.9.1 +* [thor] ~> 0.15 ## Install $ gem install ore @@ -115,11 +145,11 @@ - Alice email: alice@example.com ## License -Copyright (c) 2010-2012 Hal Brodigan +Copyright (c) 2010-2015 Hal Brodigan See {file:LICENSE.txt} for license information. [git]: http://git-scm.com/ [hg]: http://mercurial.selenic.com/ @@ -132,6 +162,10 @@ [markdown]: http://daringfireball.net/projects/markdown/ [textile]: http://textile.sitemonks.com/ [yard]: http://yardoc.org/ [rspec]: http://rspec.info/ [test_unit]: http://test-unit.rubyforge.org/ -[mini_test]: https://github.com/seattlerb/minitest#readme +[minitest]: https://github.com/seattlerb/minitest#readme +[travis.yml]: http://docs.travis-ci.com/user/languages/ruby/ + +[ruby]: https://www.ruby-lang.org/ +[thor]: https://github.com/wycats/thor#readme