README.md in ore-0.7.2 vs README.md in ore-0.8.0
- old
+ new
@@ -6,46 +6,38 @@
* [Email](mailto:postmodern.mod3 at gmail.com)
* IRC: irc.freenode.net #ruby-ore
## 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.
+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 information in **one YAML file** (`gemspec.yml`).
-* **Does not** impose a development workflow onto the developer. One could
- even use Ore with `Jeweler::Tasks`.
-* **Can** load the project version from:
- * `VERSION` or `VERSION.yml` files.
- * `VERSION` constants or `Version` modules defined in a `version.rb` file.
-* **Can** be used in traditional `.gemspec` files:
+* Stores project metadata in **one YAML file** (`gemspec.yml`).
+* Generates a **pure Ruby** `.gemspec` supporting:
+ * Git
+ * `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:
- require 'ore/specification'
-
- begin
- Ore::Specification.new do |gemspec|
- # custom logic here
- end
- rescue NameError
- begin
- require 'ore/specification'
- retry
- rescue LoadError
- STDERR.puts "The '#{__FILE__}' file requires Ore."
- STDERR.puts "Run `gem install ore-core` to install Ore."
- end
- end
+ $ ore install git://github.com/ruby-ore/cucumber.git
-* Provides an **extendable** project **generator** that supports
- user-installed templates.
-
## Requirements
* [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
## Install
$ gem install ore
@@ -53,11 +45,11 @@
## Example gemspec.yml File
The `gemspec.yml` file used to build Ore:
name: ore
- version: 0.7.2
+ version: 0.8.0
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
@@ -65,11 +57,10 @@
license: MIT
authors: Postmodern
email: postmodern.mod3@gmail.com
homepage: http://github.com/ruby-ore/ore
- has_yard: true
post_install_message: |
**************************************************************************
Generate a new Ruby library:
$ mine my_library --rspec --yard
@@ -84,19 +75,20 @@
**************************************************************************
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.6.1
+ yard: ~> 0.7.0
For a complete refrence to the `gemspec.yml` file, please see the
-[GemspecYML Reference](http://rubydoc.info/gems/ore-core/file/GemspecYML.html).
+[GemspecYML Reference](http://rubydoc.info/gems/ore/file/GemspecYML.html).
## Synopsis
Install a custom template:
@@ -118,10 +110,10 @@
$ mine my_project --bundler --rspec --yard
Generate a new project using previously installed templates:
- $ mine my_project --bundler --rspec --yard --template mini_test
+ $ mine my_project --bundler --rspec --yard --templates mini_test
Add default generator options to `~/.ore/options.yml`:
ore_tasks: true
rspec: true