From fa32da179de944724e4ad3f24d88af0774207bb6 Mon Sep 17 00:00:00 2001 From: Sean Gilligan Date: Sun, 4 Jan 2015 17:31:07 -0800 Subject: [PATCH 1/5] Move README to README.md --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 867b7885df24c8a98ac3c58edb2b1dff3d94971d Mon Sep 17 00:00:00 2001 From: Sean Gilligan Date: Sun, 4 Jan 2015 19:24:06 -0800 Subject: [PATCH 2/5] Use markdown formatting in a few places. --- README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 80bcccd..0ef9118 100644 --- a/README.md +++ b/README.md @@ -12,39 +12,51 @@ Prerequisites Building with Ant ----------------- -Type: ant clean test +Type: -Downloaded files will be stored in the local Maven repository (typically "/.m2/repository"). + ant clean test + +Downloaded files will be stored in the local Maven repository (typically *user_home*`/.m2/repository`). Building with Gradle -------------------- -Type: ./gradlew clean test +Type: + + ./gradlew clean test -Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically "/.gradle"). +Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically *user_home*`/.gradle`). Building with Maven ------------------- -Type: mvn clean test +Type: + + mvn clean test -Downloaded files will be stored in the local Maven repository (typically "/.m2/repository"). +Downloaded files will be stored in the local Maven repository (typically *user_home*`/.m2/repository`). Creating an Eclipse project --------------------------- -Type: ./gradlew cleanEclipse eclipse +Type: -Make sure you have a recent version of the Groovy Eclipse plugin installed. After importing the generated project into a workspace, go to Preferences->Java->Build Path->Classpath Variables and add a variable named GRADLE_CACHE with value "/.gradle/cache". (If you have an environment variable GRADLE_USER_HOME set, the correct value is "/cache".) You should now be able to build the project, and to run the specs like you would run a JUnit test. See http://wiki.spockframework.org/GettingStarted#Eclipse for more information on how to get started with Spock and Eclipse. + ./gradlew cleanEclipse eclipse + +Make sure you have a recent version of the Groovy Eclipse plugin installed. After importing the generated project into a workspace, go to Preferences->Java->Build Path->Classpath Variables and add a variable named `GRADLE_CACHE` with value *user_home*`/.gradle/cache`. (If you have an environment variable `GRADLE_USER_HOME` set, the correct value is *GRADLE_USER_HOME*`/cache`.) You should now be able to build the project, and to run the specs like you would run a JUnit test. See http://wiki.spockframework.org/GettingStarted#Eclipse for more information on how to get started with Spock and Eclipse. Creating an IDEA project --------------------------- -Type: ./gradlew cleanIdea idea +Type: + + ./gradlew cleanIdea idea Open the generated project in IDEA. You should now be able to build the project, and to run the specs like you would run a JUnit test. Getting hold of the Jars used in this project --------------------------------------------- -Type: ./gradlew collectJars +Type: + + ./gradlew collectJars -The Jars will be copied to build/output/lib. The comments in build.gradle explain what they are needed for. +The Jars will be copied to `build/output/lib`. The comments in `build.gradle` explain what they are needed for. Further Resources ----------------- From 4560d7540875e1905cae90782ea3b258d144c1e2 Mon Sep 17 00:00:00 2001 From: Sean Gilligan Date: Sun, 4 Jan 2015 19:33:43 -0800 Subject: [PATCH 3/5] =?UTF-8?q?Use=20markdown=20links=20in=20=E2=80=9CFurt?= =?UTF-8?q?her=20Resources=E2=80=9D=20section?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0ef9118..bf84653 100644 --- a/README.md +++ b/README.md @@ -60,21 +60,22 @@ The Jars will be copied to `build/output/lib`. The comments in `build.gradle` ex Further Resources ----------------- -Spock homepage http://spockframework.org -Spock web console http://meet.spockframework.org -Main documentation http://wiki.spockframework.org/SpockBasics -User discussion group http://forum.spockframework.org -Dev discussion group http://dev.forum.spockframework.org -Issue tracker http://issues.spockframework.org -Build server http://builds.spockframework.org -Maven repository http://m2repo.spockframework.org (releases are also available from Maven Central) -Spock blog http://blog.spockframework.org -Spock on Twitter http://twitter.com/pniederw - -Ant homepage http://ant.apache.org -Gradle homepage http://www.gradle.org -Groovy homepage http://groovy.codehaus.org -Maven homepage http://maven.apache.org + +* [Spock homepage](http://spockframework.org) +* [Spock web console](http://meet.spockframework.org) +* [Main documentation](http://wiki.spockframework.org/SpockBasics) +* [User discussion group](http://forum.spockframework.org) +* [Dev discussion group](http://dev.forum.spockframework.org) +* [Issue tracker](http://issues.spockframework.org) +* [Build server](http://builds.spockframework.org) +* [Maven repository](http://m2repo.spockframework.org) (releases are also available from Maven Central) +* [Spock blog](http://blog.spockframework.org) +* [Spock on Twitter](http://twitter.com/pniederw) + +* [Ant homepage](http://ant.apache.org) +* [Gradle homepage](http://www.gradle.org) +* [Groovy homepage](http://groovy.codehaus.org) +* [Maven homepage](http://maven.apache.org) If you have any comments or questions, please direct them to the Spock discussion group. All feedback is appreciated! From bc13dd61617e48c62f53d18d43ab7496308259eb Mon Sep 17 00:00:00 2001 From: Sean Gilligan Date: Sun, 4 Jan 2015 19:39:01 -0800 Subject: [PATCH 4/5] Get rid of some blank lines (minor cleanup) --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index bf84653..8f4d155 100644 --- a/README.md +++ b/README.md @@ -68,10 +68,9 @@ Further Resources * [Dev discussion group](http://dev.forum.spockframework.org) * [Issue tracker](http://issues.spockframework.org) * [Build server](http://builds.spockframework.org) -* [Maven repository](http://m2repo.spockframework.org) (releases are also available from Maven Central) +* [Maven repository](http://m2repo.spockframework.org) - releases are also available from Maven Central * [Spock blog](http://blog.spockframework.org) * [Spock on Twitter](http://twitter.com/pniederw) - * [Ant homepage](http://ant.apache.org) * [Gradle homepage](http://www.gradle.org) * [Groovy homepage](http://groovy.codehaus.org) From a84d7c82a1904b3954cef9472bca96f25260b49f Mon Sep 17 00:00:00 2001 From: Sean Gilligan Date: Sun, 4 Jan 2015 19:41:09 -0800 Subject: [PATCH 5/5] There should be a paragraph break here --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 8f4d155..2f291d4 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Spock Framework Example Project =============================== The purpose of this project is to help you get started with Spock. The project includes several example specifications and build scripts for Ant, Gradle, and Maven. It also makes it easy to create an Eclipse or IDEA project, allowing you to run the example specs from within your IDE. + All three builds (Ant, Gradle, Maven) will automatically download all required dependencies, compile the project, and finally run the example specs. The Gradle build goes one step further by bootstrapping itself, alleviating the need to have a build tool preinstalled. Prerequisites