Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

README improvments, added MIT-LICENSE

  • Loading branch information...
commit f8029181543b4bc4bdea03735a3b1e558fd66501 1 parent b6448e7
Dan Croak croaky authored

Showing 2 changed files with 59 additions and 35 deletions. Show diff stats Hide diff stats

  1. +21 0 MIT-LICENSE
  2. +38 35 README.textile → README.md
21 MIT-LICENSE
... ... @@ -0,0 +1,21 @@
  1 +The MIT License
  2 +
  3 +Copyright (c) 2011 thoughtbot, inc.
  4 +
  5 +Permission is hereby granted, free of charge, to any person obtaining a copy
  6 +of this software and associated documentation files (the "Software"), to deal
  7 +in the Software without restriction, including without limitation the rights
  8 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9 +copies of the Software, and to permit persons to whom the Software is
  10 +furnished to do so, subject to the following conditions:
  11 +
  12 +The above copyright notice and this permission notice shall be included in
  13 +all copies or substantial portions of the Software.
  14 +
  15 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 +THE SOFTWARE.
73 README.textile → README.md
Source Rendered
... ... @@ -1,21 +1,23 @@
1   -h1. Appraisal
  1 +Appraisal
  2 +=========
2 3
3 4 Find out what your Ruby gems are worth.
4 5
5   -h2. Synopsis
  6 +Synopsis
  7 +--------
6 8
7 9 Appraisal integrates with bundler and rake to test your library against
8 10 different versions of dependencies in repeatable scenarios called "appraisals."
9 11 Appraisal is designed to make is easy to check for regressions in your library
10 12 without interfering with day-to-day development using bundler.
11 13
12   -h2. Installation
  14 +Installation
  15 +------------
13 16
14   -<pre>
15   -gem install appraisal
16   -</pre>
  17 + gem install appraisal
17 18
18   -h2. Setup
  19 +Setup
  20 +-----
19 21
20 22 Setting up appraisal requires an Appraisals file (similar to a Gemfile) in your
21 23 project root, and some slight changes to your project's Rakefile.
@@ -24,15 +26,13 @@ An Appraisals file consists of several appraisal definitions. An appraisal
24 26 definition is simply a list of gem dependencies. For example, to test with a
25 27 few versions of Rails:
26 28
27   -<pre>
28   -appraise "rails2" do
29   - gem "rails", "2.3.9"
30   -end
  29 + appraise "rails2" do
  30 + gem "rails", "2.3.9"
  31 + end
31 32
32   -appraise "rails3" do
33   - gem "rails", "3.0.0"
34   -end
35   -</pre>
  33 + appraise "rails3" do
  34 + gem "rails", "3.0.0"
  35 + end
36 36
37 37 The dependencies in your Appraisals file are combined with dependencies in your
38 38 Gemfile, so you don't need to repeat anything that's the same for each
@@ -41,48 +41,40 @@ version from the appraisal takes precedence.
41 41
42 42 Once you have an Appraisals file set up, just require appraisal in your Rakefile:
43 43
44   -<pre>
45   -require 'appraisal'
46   -</pre>
  44 + require 'appraisal'
47 45
48 46 It's also recommended that you setup bundler at the very top of your Rakefile,
49 47 so that you don't need to constantly run bundle exec:
50 48
51   -<pre>
52   -require 'rubygems'
53   -require 'bundler/setup'
54   -</pre>
  49 + require 'rubygems'
  50 + require 'bundler/setup'
55 51
56   -h2. Usage
  52 +Usage
  53 +-----
57 54
58 55 Once you've configured the appraisals you want to use, you need to install the
59 56 dependencies for each appraisal:
60 57
61   -<pre>
62   -rake appraisal:install
63   -</pre>
  58 + rake appraisal:install
64 59
65 60 This will resolve, install, and lock the dependencies for that appraisal using
66 61 bundler. Once you have your dependencies setup, you can run any rake task in a
67 62 single appraisal:
68 63
69   -<pre>
70   -rake appraisal:rails2 test
71   -</pre>
  64 + rake appraisal:rails2 test
72 65
73 66 This will run your "test" rake task using the dependencies configured for Rails
74 67 2. You can also run each appraisal in turn:
75 68
76   -<pre>
77   -rake appraisal test
78   -</pre>
  69 + rake appraisal test
79 70
80 71 If you want to use only the dependencies from your Gemfile, just run "rake
81 72 test" as normal. This allows you to keep running with the latest versions of
82 73 your dependencies in quick test runs, but keep running the tests in older
83 74 versions to check for regressions.
84 75
85   -h2. Under the hood
  76 +Under the hood
  77 +--------------
86 78
87 79 Running "rake appraisal:install" generates a Gemfile for each appraisal by
88 80 combining your root Gemfile with the specific requirements for each appraisal.
@@ -91,7 +83,18 @@ control to ensure that the same versions are always used. When running rake
91 83 tasks for an appraisal, the rake task is run with the appropriate Gemfile for
92 84 that appraisal, ensuring the correct dependencies are used.
93 85
94   -h2. Author
  86 +Credits
  87 +-------
95 88
96   -Copyright 2010 Joe Ferris
  89 +![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
97 90
  91 +Diesel is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
  92 +
  93 +Thank you to all [the contributors](https://github.com/thoughtbot/diesel/contributors)!
  94 +
  95 +The names and logos for thoughtbot are trademarks of thoughtbot, inc.
  96 +
  97 +License
  98 +-------
  99 +
  100 +Diesel is Copyright © 2011 Joe Ferris and thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

0 comments on commit f802918

Sébastien Grosjean

You might like to replace Diesel by Appraisal ;-)

Dan Croak

Thanks, fixed.

Please sign in to comment.
Something went wrong with that request. Please try again.