Skip to content

Commit 541c3ef

Browse files
committed
Reformat Readme to have one sentence per line
And use bash format for example commands
1 parent 1fc3c92 commit 541c3ef

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.adoc

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,21 @@ image::https://badges.gitter.im/spockframework/spock.svg[link=https://gitter.im/
88
== Spock Framework Example Project
99

1010

11-
The purpose of this project is to help you get started with Spock. The project includes several example specifications and build scripts for 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.
11+
The purpose of this project is to help you get started with Spock.
12+
The project includes several example specifications and build scripts for Gradle and Maven.
13+
It also makes it easy to create an Eclipse or IDEA project, allowing you to run the example specs from within your IDE.
1214

13-
All builds (Gradle and 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.
15+
All builds (Gradle and Maven) will automatically download all required dependencies, compile the project, and finally run the example specs.
16+
The Gradle build goes one step further by bootstrapping itself, alleviating the need to have a build tool preinstalled.
1417

1518
=== Prerequisites
1619

1720
- JDK 17 or higher
1821
- Maven use `mvnw` wrapper
1922
- Gradle use `gradlew` wrapper
2023

21-
NOTE: This example shows the usage of Spock 2.0, which uses the JUnit Platform. If you want to see how to get Spock 1.x with JUnit 4 up and running see the https://github.com/spockframework/spock-example/tree/spock-1.x[Spock-1.x] Branch.
24+
NOTE: This example shows the usage of Spock 2.0, which uses the JUnit Platform.
25+
If you want to see how to get Spock 1.x with JUnit 4 up and running see the https://github.com/spockframework/spock-example/tree/spock-1.x[Spock-1.x] Branch.
2226

2327
NOTE: Spock supports Java 8, but Groovy 5.0 requires Java 11+ and Gradle 9+ requires Java 17+.
2428
So for simplicity’s sake the example uses Java 17.
@@ -28,14 +32,20 @@ NOTE: Spock supports Java 8, but Groovy 5.0 requires Java 11+ and Gradle 9+ requ
2832
=== Building with Gradle
2933
Type:
3034

31-
./gradlew clean test
35+
[source,bash]
36+
----
37+
./gradlew clean test
38+
----
3239

3340
Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically *user_home*`/.gradle`).
3441

3542
=== Building with Maven
3643
Type:
3744

38-
./mvnw clean test
45+
[source,bash]
46+
----
47+
./mvnw clean test
48+
----
3949

4050
Downloaded files will be stored in the local Maven repository (typically *user_home*`/.m2/repository`).
4151

0 commit comments

Comments
 (0)