Skip to content

Commit

Permalink
Update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
Guy Davenport committed Nov 12, 2024
1 parent efd4706 commit c19c490
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 72 deletions.
9 changes: 1 addition & 8 deletions java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
38 changes: 7 additions & 31 deletions java/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
Expand All @@ -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
Expand Down
36 changes: 3 additions & 33 deletions java/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,28 @@ 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
```

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
```

0 comments on commit c19c490

Please sign in to comment.