Update the README.

main
KKlochko 2 years ago
parent afc43f49eb
commit 8cdb151357

@ -1,27 +0,0 @@
== simple-jbdd
This project is a simple BDD framework.
The project uses the https://github.com/spockframework/[Spock Framework Example Project^]
=== Prerequisites
- JDK 17 or higher
- Maven use `mvnw` wrapper
- Gradle use `gradlew` wrapper
=== Building with Gradle
Type:
./gradlew clean test
Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically *user_home*`/.gradle`).
=== Building with Maven
Type:
./mvnw clean test
Downloaded files will be stored in the local Maven repository (typically *user_home*`/.m2/repository`).

@ -0,0 +1,67 @@
# simple-jbdd
This project is a simple BDD framework.
The project uses the [Spock Framework Example Project](https://github.com/spockframework/)
## Prerequisites
- JDK 17 or higher
- Maven use `mvnw` wrapper
- Gradle use `gradlew` wrapper
## Building with Gradle
Downloaded files (including the Gradle distribution itself) will be stored in the Gradle user home directory (typically **user_home**`/.gradle`).
Type: test
```shell
./gradlew clean test
```
Type: build
```shell
./gradlew clean build
```
Type: run with asserts
```shell
java -ea -jar ./build/libs/simple_jbdd-0.13.2-all.jar
```
## Building with Maven
Downloaded files will be stored in the local Maven repository (typically **user_home**`/.m2/repository`).
Type: test
```shell
./mvnw clean test
```
Type: build
```shell
./mvnw clean package
```
Type: run with asserts
```shell
java -ea -jar ./target/simple_jbdd-0.13.2.jar
```
## Building with Maven
Kostiantyn Klochko (c) 2023
## License
Under the GNU Lesser General Public License v3.0 or later.
Loading…
Cancel
Save