Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 60 lines (35 sloc) 1.578 kb
298821d Initial commit with gem skeleton.
Luis Hurtado authored
1 # Gitnesse
2
246f99f @deadprogram Minor readme fix
deadprogram authored
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
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
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
23
dab210d @stewart Updated readme to reflect changes
stewart authored
24 Gitnesse.config do
25 repository_url "git@github.com:hybridgroup/gitnesse-demo.wiki"
f984fd4 Add installation and usage instructions.
Luis Hurtado authored
26 end
27
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up ot...
deadprogram authored
28 ## Usage In Rails 3
298821d Initial commit with gem skeleton.
Luis Hurtado authored
29
1647b08 README update.
Luis Hurtado authored
30 For Rails 3 there is a rake task:
f984fd4 Add installation and usage instructions.
Luis Hurtado authored
31
32 $ rake gitnesse
33
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up ot...
deadprogram authored
34 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
35
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up ot...
deadprogram authored
36 ## Usage In Sinatra
7f3df5d @deadprogram Refactoring into smaller more granular methods
deadprogram authored
37
38 For Rails 3 there is a rake task:
39
d054b73 @deadprogram Should better handle auto-require for rake tasks in Rails, and DRY up ot...
deadprogram authored
40 There is an example application using Sinatra located here: [https://github.com/hybridgroup/gitnesse-example-sinatra](https://github.com/hybridgroup/gitnesse-example-sinatra)
41
42 ## Other Usage
43
44 Want to use plain old Gitnesse? There is an executable that requires the path to the configuration file:
45
46 $ GITNESSE_CONFIG='./gitnesse_config.rb' gitnesse
47
7f3df5d @deadprogram Refactoring into smaller more granular methods
deadprogram authored
48 ## TODO
49
50 - implement git push back to git wiki
51 - rake tasks for push/pull/run
52
298821d Initial commit with gem skeleton.
Luis Hurtado authored
53 ## Contributing
54
55 1. Fork it
56 2. Create your feature branch (`git checkout -b my-new-feature`)
57 3. Commit your changes (`git commit -am 'Add some feature'`)
58 4. Push to the branch (`git push origin my-new-feature`)
59 5. Create new Pull Request
Something went wrong with that request. Please try again.