From 60a02a431fde88cd5d2d3174a2d54d95bfd520fc Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Thu, 5 May 2016 14:37:58 +0100 Subject: [PATCH] Improve documentation of project's requirements Closes gh-217 --- README.md | 2 +- docs/src/docs/asciidoc/getting-started.adoc | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aaa0c6dc..a1488ceb 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ To learn more about Spring REST Docs, please consult the [reference documentatio ## Building from source -Spring REST Docs requires Java 7 or later and is built using [Gradle][10]: +You will need Java 7 or later to build Spring REST Docs. It is built using [Gradle][10]: ``` ./gradlew build diff --git a/docs/src/docs/asciidoc/getting-started.adoc b/docs/src/docs/asciidoc/getting-started.adoc index 8c0dba9d..eb9c1fe5 100644 --- a/docs/src/docs/asciidoc/getting-started.adoc +++ b/docs/src/docs/asciidoc/getting-started.adoc @@ -39,7 +39,18 @@ If you want to jump straight in, a number of sample applications are available: |=== +[[getting-started-requirements]] +=== Requirements +Spring REST Docs has the following minimum requirements: + +- Java 7 +- Spring Framework 4.2 + +Additionally, the `spring-restdocs-restassured` module has the following minimum +requirements: + +- REST Assured 2.8 [[getting-started-build-configuration]] === Build configuration