Skip to content

Commit

Permalink
restructured readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bischoffdev committed Apr 18, 2018
1 parent f93eb89 commit 6e8dac1
Showing 1 changed file with 37 additions and 37 deletions.
74 changes: 37 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@


- [Cluecumber Report Maven Plugin](#cluecumber-report-maven-plugin)
- [Generated pages](#generated-pages)
- [Test suite overview page](#test-suite-overview-page)
- [Scenario detail pages](#scenario-detail-pages)
- [Tag statistics page](#tag-statistics-page)
- [Changelog](#changelog)
- [Prerequisites](#prerequisites)
- [Maven POM settings](#maven-pom-settings)
Expand All @@ -24,10 +28,6 @@
- [Optional Configuration Parameters](#optional-configuration-parameters)
- [CustomParameters](#customparameters)
- [Example](#example)
- [Generated pages](#generated-pages)
- [Test suite overview page](#test-suite-overview-page)
- [Scenario detail pages](#scenario-detail-pages)
- [Tag statistics page](#tag-statistics-page)
- [Example project](#example-project)
- [Additional Information](#additional-information)
- [Building](#building)
Expand All @@ -49,6 +49,39 @@ This project was created because

**Note:** If you need to run Cucumber tests in parallel, please check out our [Cucable](https://github.com/trivago/cucable-plugin) project!

# Generated pages

## Test suite overview page

This page shows the most important information about the test suite:

- run time
- number of passed, failed and skipped scenarios
- grouped scenarios by status
- optional custom parameters

![report_overview](documentation/img/report_overview.png)

## Scenario detail pages

The scenario detail pages can be reached by clicking on the scenario name in the test suite overview page.

It shows:

- scenario name and description
- step runtimes and status
- before and after steps
- stack traces of failed steps
- screenshots

![report_detail](documentation/img/report_details.png)

## Tag statistics page

The tag statistics page shows an overview about the used tags and passed, failed and skipped scenarios with those tags.

![tags](documentation/img/tags.png)

## Changelog

All changes are documented in the [full changelog](CHANGELOG.md).
Expand Down Expand Up @@ -129,39 +162,6 @@ Valid URLs that start with a protocol (http, https, ftp) are automatically recog

![custom parameters](documentation/img/custom_params.png)

# Generated pages

## Test suite overview page

This page shows the most important information about the test suite:

- run time
- number of passed, failed and skipped scenarios
- grouped scenarios by status
- optional custom parameters

![report_overview](documentation/img/report_overview.png)

## Scenario detail pages

The scenario detail pages can be reached by clicking on the scenario name in the test suite overview page.

It shows:

- scenario name and description
- step runtimes and status
- before and after steps
- stack traces of failed steps
- screenshots

![report_detail](documentation/img/report_details.png)

## Tag statistics page

The tag statistics page shows an overview about the used tags and passed, failed and skipped scenarios with those tags.

![tags](documentation/img/tags.png)

# Example project

You can test the complete flow and POM configuration by checking out the [Cucable example project](example-project).
Expand Down

0 comments on commit 6e8dac1

Please sign in to comment.