Skip to content
dismaldenizen edited this page Sep 14, 2010 · 9 revisions

The project files

If you follow these conventions, your Rakefile will be considerably shorter.

  • VERSION: file containing only a version number (eg ‘1.2.3’).
  • README.*: ReadMe file with extension indicating its markup.
  • LICENSE: file containing the project’s license.
  • spec/**/*_spec.rb: RSpec examples.

The Rakefile

Here is a minimalist Burke Rakefile.

require 'rubygems'
require 'burke'

Burke.enable_all

Burke.setup do |s|
  s.name = 'name'
  s.summary = 'A short summary of the project.'

  s.gems do |g|
    g.platform 'ruby'
  end
end

Assuming that your project follows the conventions mentioned above, tasks will be available for building a gem, installing the gem, running RSpec examples and generating documentation.

Clone this wiki locally