serenity-bdd / serenity-documentation

The main Serenity BDD documentation
Apache License 2.0
41 stars 61 forks source link

= Serenity BDD Documentation

This project contains the main Serenity BDD documentation. The documentation is broken up into chapters, so many people can contribute simultaneously.

== Building and contributing

The Serenity documentation is written in Asciidoc. The build uses Gradle and Asciidoctor. You can generate the documentation by running the asciidoctor task:

$ gradle clean asciidoctor

The documentation is generated in [path]build/asciidoc.

The master document is [path]index.asc. All of the chapters are included into this document.

All of the source code in the documentation is included as snippets from the sample projects in the [path]src/sample directory. Look in [path]src/ascidoc/first-steps.asc to see an example of how this is done.