README.md in ore-0.8.1 vs README.md in ore-0.9.0

- old
+ new

@@ -1,111 +1,91 @@ # Ore -* [Source](http://github.com/ruby-ore/ore) -* [Issues](http://github.com/ruby-ore/ore/issues) +* [Source](https://github.com/ruby-ore/ore) +* [Issues](https://github.com/ruby-ore/ore/issues) * [Documentation](http://rubydoc.info/gems/ore/frames) * [Email](mailto:postmodern.mod3 at gmail.com) -* IRC: irc.freenode.net #ruby-ore ## 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. ## Features -* Stores project metadata in **one YAML file** (`gemspec.yml`). -* Generates a **pure Ruby** `.gemspec` supporting: - * [Git](http://git-scm.com/) - * [Mercurial (Hg)](http://mercurial.selenic.com/) - * [SubVersion (SVN)](http://subversion.tigris.org/) - * `gemspec.yml` - * `VERSION` or `version.rb` files -* Provides many builtin templates: - * bundler - * rvmrc - * jeweler - * rdoc - * yard - * test_unit - * rspec - * gem_test -* Allows installing custom templates from Git repositories: +### SCMs - $ ore install git://github.com/ruby-ore/cucumber.git +Ore supports generating [Git][git], [Mercurial][hg] and [SubVersion][svn] +enabled projects. -## Requirements + $ mine my-project [--git | --hg] -* [ore-core](http://github.com/ruby-ore/ore-core) ~> 0.1, >= 0.1.4 -* [env](http://github.com/postmodern/env) ~> 0.1.2 -* [thor](http://github.com/wycats/thor) ~> 0.14.3 +### Gemspec -## Install +Ore generates a pure-Ruby gemspec by default. Ore can also generate a +[gemspec.yml] file. - $ gem install ore +### Tasks -## Example gemspec.yml File +Ore supports generating projects using [Gem::Tasks][rubygems_tasks], +[Bundler::GemHelper][bundler], [Jeweler::Tasks][jeweler] and even +[Gem::PackageTask][gem_package_task]. -The `gemspec.yml` file used to build Ore: + $ mine my-project [--rubygems-tasks | + --bundler-tasks | + --jeweler-tasks | + --gem-package-task] - name: ore - version: 0.8.1 - summary: Mine raw RubyGems from YAML. - description: - Ore is a simple RubyGem building solution. Ore handles the - creation of Gem::Specification objects as well as building '.gem' - files. Ore allows the developer to keep all of the project information - in a single YAML file. - - license: MIT - authors: Postmodern - email: postmodern.mod3@gmail.com - homepage: http://github.com/ruby-ore/ore - post_install_message: | - ************************************************************************** - Generate a new Ruby library: - - $ mine my_library --rspec --yard - - Build the library: - - $ rake build - - Release the library to rubygems.org: - - $ rake release - - ************************************************************************** - - dependencies: - ore-core: ~> 0.1, >= 0.1.4 - env: ~> 0.1.2 - thor: ~> 0.14.3 - - development_dependencies: - ore-tasks: ~> 0.4 - rspec: ~> 2.4 - yard: ~> 0.7.0 +### Bundler -For a complete refrence to the `gemspec.yml` file, please see the -[GemspecYML Reference](http://rubydoc.info/gems/ore/file/GemspecYML.html). +Ore can also generate a [Bundler][bundler] project. -## Synopsis + $ mine my-project --bundler -Install a custom template: +### RVM +Ore also includes an [.rvmrc] template. + + $ mine my-project --rvmrc + +### Markup + +Ore supports [RDoc][rdoc], [Markdown][markdown] and [Textile][textile] markup. + + $ mine my-project [--rdoc | --markdown | --textile] + +### Documentation + +Ore supports generating projects with [RDoc][rdoc] or [YARD][yard] +documentation. + + $ mine my-project [--rdoc | --yard] + +### Testing + +Ore supports generating [RSpec][rspec] or [Test::Unit][test_unit] tests. + + $ mine my-project [--test-unit | --rspec] + +### Custom Templates + +Additional templates can also be installed from Git: + $ ore install git://github.com/ruby-ore/mini_test.git + $ mine my-project --mini-test -List installed templates: +## Requirements - $ ore list +* [thor](http://github.com/wycats/thor) ~> 0.14.3 -Remove a previously installed template: +## Install - $ ore remove mini_test + $ gem install ore +## Synopsis + Generate a new project: $ mine my_project Generate a new customized project: @@ -114,24 +94,49 @@ Generate a new project using previously installed templates: $ mine my_project --bundler --rspec --yard --templates mini_test +Install a custom template: + + $ ore install git://github.com/ruby-ore/mini_test.git + +List installed templates: + + $ ore list + +Remove a previously installed template: + + $ ore remove mini_test + Add default generator options to `~/.ore/options.yml`: - ore_tasks: true - rspec: true - yard: true - markdown: true + gemspec_yml: true + rubygems_tasks: true + rspec: true + yard: true + markdown: true authors: - Alice email: alice@example.com -Build a `.gem` file in the `pkg/` directory of a project: - - $ ore gem - ## License -Copyright (c) 2010-2011 Hal Brodigan +Copyright (c) 2010-2012 Hal Brodigan See {file:LICENSE.txt} for license information. + +[git]: http://git-scm.com/ +[hg]: http://mercurial.selenic.com/ +[svn]: http://subversion.tigris.org/ +[gemspec.yml]: https://github.com/ruby-ore/ore/blob/master/gemspec.yml +[rubygems_tasks]: https://github.com/postmodern/rubygems-tasks#readme +[bundler]: http://gembundler.com/ +[jeweler]: https://github.com/technicalpickles/jeweler#readme +[gem_package_task]: http://rubygems.rubyforge.org/rubygems-update/Gem/PackageTask.html +[.rvmrc]: https://rvm.io/workflow/rvmrc/#project +[rdoc]: http://rdoc.rubyforge.org/ +[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/