Skip to content
Newer
Older
100644 69 lines (42 sloc) 1.95 KB
298821d Initial commit with gem skeleton.
Luis Hurtado authored Oct 11, 2012
1 # Gitnesse
2
246f99f @deadprogram Minor readme fix
deadprogram authored Nov 1, 2012
3 Gitnesse is a Cucumber-wiki integration tool.
4 It enables a project to store cucumber features in a git-based wiki, and then test them against your code.
5 Conceptually influenced by Fitnesse http://fitnesse.org/
298821d Initial commit with gem skeleton.
Luis Hurtado authored Oct 11, 2012
6
7 ## Installation
8
9 Add this line to your application's Gemfile:
10
11 gem 'gitnesse'
12
13 And then execute:
14
15 $ bundle
16
17 Or install it yourself as:
18
19 $ gem install gitnesse
20
dab210d @stewart Updated readme to reflect changes
stewart authored Nov 13, 2012
21 Create a `gitnesse.rb` file somewhere in your project, and add something like
22 the following to it:
f984fd4 Add installation and usage instructions.
Luis Hurtado authored Oct 15, 2012
23
66eb101 @stewart Simplified and extracted config to Gitnesse::Configuration
stewart authored Nov 30, 2012
24 Gitnesse.configure do |config|
25 config.repository_url = "git@github.com:hybridgroup/gitnesse-demo.wiki"
c27e970 @stewart Added config variables :annotate_results and :info
stewart authored Dec 3, 2012
26 config.annotate_results = true
27 config.info = "Bob Martin's development laptop"
f984fd4 Add installation and usage instructions.
Luis Hurtado authored Oct 15, 2012
28 end
29
6ff6a84 @deadprogram Update for newer, better examples
deadprogram authored Nov 14, 2012
30 ## rake tasks
31
32 $ rake gitnesse:pull
33 $ rake gitnesse:push
34 $ rake gitnesse:run
35 $ rake gitnesse:info
0a368c0 @stewart Minor updates to README
stewart authored Dec 5, 2012
36 $ rake gitnesse:push_results
298821d Initial commit with gem skeleton.
Luis Hurtado authored Oct 11, 2012
37
6ff6a84 @deadprogram Update for newer, better examples
deadprogram authored Nov 14, 2012
38 ## Usage In Rails 3
f984fd4 Add installation and usage instructions.
Luis Hurtado authored Oct 15, 2012
39
6ff6a84 @deadprogram Update for newer, better examples
deadprogram authored Nov 14, 2012
40 For Rails 3 the rake tasks should automatically just appear, as long as you have added the gitnesse gem to your Gemfile.
f984fd4 Add installation and usage instructions.
Luis Hurtado authored Oct 15, 2012
41
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up…
deadprogram authored Nov 13, 2012
42 There is an example application using Rails 3 located here: [https://github.com/hybridgroup/gitnesse-example-rails](https://github.com/hybridgroup/gitnesse-example-rails)
f984fd4 Add installation and usage instructions.
Luis Hurtado authored Oct 15, 2012
43
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up…
deadprogram authored Nov 14, 2012
44 ## Usage In Sinatra
7f3df5d @deadprogram Refactoring into smaller more granular methods
deadprogram authored Nov 1, 2012
45
6ff6a84 @deadprogram Update for newer, better examples
deadprogram authored Nov 14, 2012
46 To use gitnesse in a Sinatra application, simple add this line of code to your Rakefile:
47
48 require "gitnesse/tasks"
7f3df5d @deadprogram Refactoring into smaller more granular methods
deadprogram authored Nov 2, 2012
49
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up…
deadprogram authored Nov 14, 2012
50 There is an example application using Sinatra located here: [https://github.com/hybridgroup/gitnesse-example-sinatra](https://github.com/hybridgroup/gitnesse-example-sinatra)
51
52 ## Other Usage
53
54 Want to use plain old Gitnesse? There is an executable that requires the path to the configuration file:
55
56 $ GITNESSE_CONFIG='./gitnesse_config.rb' gitnesse
57
7f3df5d @deadprogram Refactoring into smaller more granular methods
deadprogram authored Nov 2, 2012
58 ## TODO
59
6ff6a84 @deadprogram Update for newer, better examples
deadprogram authored Nov 14, 2012
60 - pluggable feature runners, so can be used with Spinach, Cucumber-JS, or ?
7f3df5d @deadprogram Refactoring into smaller more granular methods
deadprogram authored Nov 2, 2012
61
298821d Initial commit with gem skeleton.
Luis Hurtado authored Oct 11, 2012
62 ## Contributing
63
64 1. Fork it
65 2. Create your feature branch (`git checkout -b my-new-feature`)
66 3. Commit your changes (`git commit -am 'Add some feature'`)
67 4. Push to the branch (`git push origin my-new-feature`)
68 5. Create new Pull Request
Something went wrong with that request. Please try again.