Skip to content

Commit c19c490

Browse files
author
Guy Davenport
committed
Update readme files
1 parent efd4706 commit c19c490

File tree

3 files changed

+11
-72
lines changed

3 files changed

+11
-72
lines changed

java/README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,9 @@ There is also a basic spring application that allow you to view the BrAPI Specif
88
1. Download the Command Line Interface (CLI) from the
99
[Releases](https://github.com/plantbreeding/brapi-schema-tools/releases) page
1010
2. Run the application on your terminal
11-
* In windows
1211

13-
```powershell
14-
brapi
1512
```
16-
17-
* In Linux or macOS
18-
19-
```shell
20-
brapi
13+
brapi
2114
```
2215
2316
## For developers

java/cli/README.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,21 @@ Depends on only the [core](../core/README.md) module.
88

99
Use Gradle to create and install the CLI in one command
1010

11-
In windows
12-
13-
```powershell
14-
./gradlew cli:installDist \path\to\installation\directory
1511
```
16-
17-
In Linux or macOS
18-
19-
```shell
20-
./gradle cli:installDist /path/to/installation/directory
12+
./gradlew cli:installDist \path\to\installation\directory
2113
```
2214

2315
Alternatively you can create a Zip or Tar achieve of the CLI including runtime libraries and OS specific scripts.
2416

25-
In windows
17+
For a Zip file
2618

27-
```powershell
19+
```
2820
./gradlew cli:distZip
2921
```
3022

31-
In Linux or macOS
23+
For a Tar file
3224

33-
```shell
25+
```
3426
./gradle cli:distTar
3527
```
3628

@@ -40,16 +32,8 @@ This will create the zip or tar archive in the cli/build/distributions directory
4032

4133
To create an Executable JAR use the Gradle command:
4234

43-
In windows
44-
45-
```powershell
46-
./gradlew cli:jar
4735
```
48-
49-
In Linux or macOS
50-
51-
```shell
52-
./gradle cli:jar
36+
./gradlew cli:jar
5337
```
5438

5539
This will create the executable JAR in the cli/build/libs directory
@@ -70,16 +54,8 @@ docker build .
7054
When you have access to the source code repository and while developing new features this is
7155
the quickest way to run the Command Line Interface. Use the Gradle command:
7256

73-
In windows
74-
75-
```shell
76-
./gradlew cli:run --args="-h"
7757
```
78-
79-
In Linux or macOS
80-
81-
```shell
82-
./gradle cli:run --args="-h"
58+
./gradlew cli:run --args="-h"
8359
```
8460

8561
Remember to replace the '-h' arguments with your required options. The '-h' option will give you a list of the available

java/core/README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,28 @@ Core Java classes for parsing the BrAPI Schema
44

55
Use gradle to build, test and publish
66

7-
## In windows
8-
97
To make a clean build use
108

11-
```powershell
12-
./gradlew clean build
13-
```
14-
15-
To make a clean build and test use
16-
17-
```powershell
18-
./gradlew clean test
19-
```
20-
21-
To make a clean build and publish locally use
22-
23-
```powershell
24-
./gradlew clean publishToMavenLcoal
25-
```
26-
27-
To make a clean build and release, you will need some secrets.
28-
It is not recommend to this from here,
29-
let the CI on GitHub handle this.
30-
31-
```powershell
32-
./gradlew clean test publish
339
```
34-
35-
## In Linux or MacOS
36-
37-
To make a clean build use
38-
39-
```shell
4010
./gradlew clean build
4111
```
4212

4313
To make a clean build and test use
4414

45-
```shell
15+
```
4616
./gradlew clean test
4717
```
4818

4919
To make a clean build and publish locally use
5020

51-
```shell
21+
```
5222
./gradlew clean publishToMavenLcoal
5323
```
5424

5525
To make a clean build and release, you will need some secrets.
5626
It is not recommend to this from here,
5727
let the CI on GitHub handle this.
5828

59-
```shell
29+
```
6030
./gradlew clean test publish
6131
```

0 commit comments

Comments
 (0)