From c19c4901883d0ec117f0eccd101306cd343707ac Mon Sep 17 00:00:00 2001 From: Guy Davenport Date: Tue, 12 Nov 2024 14:41:42 +1300 Subject: [PATCH] Update readme files --- java/README.md | 9 +-------- java/cli/README.md | 38 +++++++------------------------------- java/core/README.md | 36 +++--------------------------------- 3 files changed, 11 insertions(+), 72 deletions(-) diff --git a/java/README.md b/java/README.md index 1049c07..b89cece 100644 --- a/java/README.md +++ b/java/README.md @@ -8,16 +8,9 @@ There is also a basic spring application that allow you to view the BrAPI Specif 1. Download the Command Line Interface (CLI) from the [Releases](https://github.com/plantbreeding/brapi-schema-tools/releases) page 2. Run the application on your terminal - * In windows - ```powershell - brapi ``` - - * In Linux or macOS - - ```shell - brapi + brapi ``` ## For developers diff --git a/java/cli/README.md b/java/cli/README.md index fc60d5a..1ea166f 100644 --- a/java/cli/README.md +++ b/java/cli/README.md @@ -8,29 +8,21 @@ Depends on only the [core](../core/README.md) module. Use Gradle to create and install the CLI in one command -In windows - -```powershell -./gradlew cli:installDist \path\to\installation\directory ``` - -In Linux or macOS - -```shell -./gradle cli:installDist /path/to/installation/directory +./gradlew cli:installDist \path\to\installation\directory ``` Alternatively you can create a Zip or Tar achieve of the CLI including runtime libraries and OS specific scripts. -In windows +For a Zip file -```powershell +``` ./gradlew cli:distZip ``` -In Linux or macOS +For a Tar file -```shell +``` ./gradle cli:distTar ``` @@ -40,16 +32,8 @@ This will create the zip or tar archive in the cli/build/distributions directory To create an Executable JAR use the Gradle command: -In windows - -```powershell -./gradlew cli:jar ``` - -In Linux or macOS - -```shell -./gradle cli:jar +./gradlew cli:jar ``` This will create the executable JAR in the cli/build/libs directory @@ -70,16 +54,8 @@ docker build . When you have access to the source code repository and while developing new features this is the quickest way to run the Command Line Interface. Use the Gradle command: -In windows - -```shell -./gradlew cli:run --args="-h" ``` - -In Linux or macOS - -```shell -./gradle cli:run --args="-h" +./gradlew cli:run --args="-h" ``` Remember to replace the '-h' arguments with your required options. The '-h' option will give you a list of the available diff --git a/java/core/README.md b/java/core/README.md index 1d0bcd6..f04143e 100644 --- a/java/core/README.md +++ b/java/core/README.md @@ -4,51 +4,21 @@ Core Java classes for parsing the BrAPI Schema Use gradle to build, test and publish -## In windows - To make a clean build use -```powershell -./gradlew clean build -``` - -To make a clean build and test use - -```powershell -./gradlew clean test -``` - -To make a clean build and publish locally use - -```powershell -./gradlew clean publishToMavenLcoal -``` - -To make a clean build and release, you will need some secrets. -It is not recommend to this from here, -let the CI on GitHub handle this. - -```powershell -./gradlew clean test publish ``` - -## In Linux or MacOS - -To make a clean build use - -```shell ./gradlew clean build ``` To make a clean build and test use -```shell +``` ./gradlew clean test ``` To make a clean build and publish locally use -```shell +``` ./gradlew clean publishToMavenLcoal ``` @@ -56,6 +26,6 @@ To make a clean build and release, you will need some secrets. It is not recommend to this from here, let the CI on GitHub handle this. -```shell +``` ./gradlew clean test publish ```