Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

Commit ce822ec

Browse files
authored
docs: describe how to run the latest release
1 parent 5627ed2 commit ce822ec

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ The `api-editor` is a tool to improve the API of a Python library in a semi-auto
66

77
The automation described above relies on structured information about the existing Python library. This information can be computed automatically by the [package-parser][package-parser].
88

9+
## For Users
10+
11+
1. Install [OpenJDK 17](https://adoptium.net/).
12+
2. Download the file `api-editor-<version>.jar` from the [latest release](https://github.com/lars-reimann/api-editor/releases/latest) (listed under "Assets").
13+
3. Run the program:
14+
```shell
15+
java -jar api-editor-<version>.jar
16+
```
17+
18+
## For Developers
19+
920
### Installation
1021

1122
1. Install [OpenJDK 17](https://adoptium.net/).

0 commit comments

Comments
 (0)