diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..c3bfb01 --- /dev/null +++ b/README.adoc @@ -0,0 +1,20 @@ += 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. diff --git a/README.md b/README.md deleted file mode 100644 index 275afa3..0000000 --- a/README.md +++ /dev/null @@ -1,17 +0,0 @@ -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 `build/asciidoc`. - -The master document is `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 `src/sample` directory. Look in `src/ascidoc/first-steps.asc' to see an example of how this is done. diff --git a/build.gradle b/build.gradle index 52c66aa..379fce6 100644 --- a/build.gradle +++ b/build.gradle @@ -4,13 +4,18 @@ buildscript { } dependencies { - classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.0' + classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.2' } } -apply plugin: 'org.asciidoctor.gradle.asciidoctor' +apply plugin: 'org.asciidoctor.convert' -version="1.0.1" +version='1.0.1.1' asciidoctor { -} \ No newline at end of file + sourceDir 'src/asciidoc' + sources { + include 'index.asc' + } + separateOutputDirs false +} diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 539441b..42a18b8 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-2.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-2.2.1-bin.zip diff --git a/src/asciidoc/index.asc b/src/asciidoc/index.asc index 7740416..4d1782a 100644 --- a/src/asciidoc/index.asc +++ b/src/asciidoc/index.asc @@ -1,10 +1,8 @@ -The Serenity Reference Manual -============================= -Version 1.0.1.1 -John Ferguson Smart @wakaleo += The Serenity Reference Manual +John Ferguson Smart +ifdef::project-version[:revnumber: {project-version}] :description: Comprehensive Reference manual for the Serenity BDD living documentation tool :lang: en -:encoding: 'iso-8859-1' :keywords: serenity-bdd, bdd, reference, learn, how to :doctype: book :compat-mode: diff --git a/src/samples/junit-quick-start/src/test/java/net/serenitybdd/samples/junit/features/searching/WhenSearchingOnGoogle.java b/src/samples/junit-quick-start/src/test/java/net/serenitybdd/samples/junit/features/searching/WhenSearchingOnGoogle.java index e7eeae0..db2ee32 100644 --- a/src/samples/junit-quick-start/src/test/java/net/serenitybdd/samples/junit/features/searching/WhenSearchingOnGoogle.java +++ b/src/samples/junit-quick-start/src/test/java/net/serenitybdd/samples/junit/features/searching/WhenSearchingOnGoogle.java @@ -29,7 +29,7 @@ public class WhenSearchingOnGoogle { @Test public void shouldInstantiateAWebDriverInstanceForAWebTest() { - driver.get("http://www.google.com"); //<3> + driver.get("http://www.google.com"); //<2> driver.findElement(By.name("q")).sendKeys("firefly", Keys.ENTER);