Skip to content

Commit

Permalink
Add executable documentation entry in README
Browse files Browse the repository at this point in the history
Add Rake task to generate doc/features.html
  • Loading branch information
gonzalo-bulnes committed Feb 19, 2014
1 parent 18750a4 commit cc5992f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,17 @@ The resulting Cucumber features are a bit verbose, and their output when errors

You can run the full test suite with `cd simple_token_authentication && rake`.

### Executable documentation

The Cucumber scenarii describe how to setup demonstration applications for different use cases. While you can read the `rake` output, you may prefer to read it in HTML format:

```bash
cd simple_token_authentication
rake features_html # generate the features documentation

# Open doc/features.html in your preferred web browser.
```

### Contributions

Contributions are welcome! I'm not keeping a list of contributors for now, but any PR which references us all will be welcome.
Expand Down
4 changes: 4 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ begin
t.cucumber_opts = "--format pretty"
end

Cucumber::Rake::Task.new(:features_html) do |t|
t.cucumber_opts = "--format html --out doc/features.html"
end

rescue LoadError
desc 'Cucumber rake task not available'
task :features do
Expand Down
Empty file added doc/.gitkeep
Empty file.

0 comments on commit cc5992f

Please sign in to comment.