Skip to content

Commit 2e837d2

Browse files
committed
Update release download links, add badges.
1 parent 5a306bf commit 2e837d2

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
# Bounding Box Editor
55
</p>
66

7-
[![Build](https://github.com/mfl28/BoundingBoxEditor/workflows/Build/badge.svg)](https://dev.azure.com/mfl28/BoundingBoxEditor/_build/latest?definitionId=1&branchName=master)
7+
[![Build](https://github.com/mfl28/BoundingBoxEditor/workflows/Build/badge.svg)](https://github.com/mfl28/BoundingBoxEditor/actions)
88
[![Codecov coverage (master)](https://codecov.io/gh/mfl28/BoundingBoxEditor/branch/master/graph/badge.svg)](https://codecov.io/gh/mfl28/BoundingBoxEditor)
99
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mfl28_BoundingBoxEditor&metric=alert_status)](https://sonarcloud.io/dashboard?id=mfl28_BoundingBoxEditor)
1010
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/mfl28/BoundingBoxEditor.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/mfl28/BoundingBoxEditor/context:java)
11-
11+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mfl28/BoundingBoxEditor?label=release)](https://github.com/mfl28/BoundingBoxEditor/releases/latest)
12+
[![License](https://img.shields.io/badge/license-GPLv3-informational)](LICENSE)
1213

1314
This is an image annotation desktop-application written in Java using the JavaFX application platform. It allows you to create bounding box annotations using rectangular and polygonal shapes.
1415
Annotations can be imported and saved from/to JSON files, [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) format XML-files or [YOLO](https://pjreddie.com/darknet/yolo/) format TXT-files.
@@ -29,19 +30,23 @@ Annotations can be imported and saved from/to JSON files, [Pascal VOC](http://ho
2930
* Tag bounding boxes using tags defined in the Pascal VOC format (truncated, difficult, occluded, pose: *, action: *)
3031
* Color-coded, searchable and fully dynamic object categories
3132

32-
## Latest Release ![GitHub release](https://img.shields.io/github/v/release/mfl28/BoundingBoxEditor)
33-
Download the latest release of *Bounding Box Editor* for your operating system from the links below. The files are zipped, custom runtime images (created using the [Badass JLink plugin](https://github.com/beryx/badass-jlink-plugin)) that contain binaries (inside the `image/bin/` folder) to start the application on your system.
33+
## Latest Release
34+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mfl28/BoundingBoxEditor?label=release&style=for-the-badge)](https://github.com/mfl28/BoundingBoxEditor/releases/latest)
35+
![platform](https://img.shields.io/static/v1.svg?label=Platform&message=Linux%20|%20macOS%20|%20Win%20&style=for-the-badge)
36+
37+
Download the latest release installer or portable image (no installation required) of *Bounding Box Editor* for your operating system from the links below. These files were created using the
38+
[jpackage](https://openjdk.java.net/jeps/343) packaging tool, the [Badass JLink Gradle plugin](https://github.com/beryx/badass-jlink-plugin) and [github-actions](.github/workflows/workflow.yml).
3439

35-
| OS |
36-
| ------------- |
37-
| [Linux](https://github.com/mfl28/BoundingBoxEditor/releases/latest/download/boundingboxeditor-linux.zip) |
38-
| [MacOs](https://github.com/mfl28/BoundingBoxEditor/releases/latest/download/boundingboxeditor-mac.zip) |
39-
| [Windows](https://github.com/mfl28/BoundingBoxEditor/releases/latest/download/boundingboxeditor-win.zip) |
40+
| OS | Installer | Portable |
41+
| ------------- | --------- | -------- |
42+
| Linux | [deb](https://github.com/mfl28/BoundingBoxEditor/releases/download/v2.2.0/boundingboxeditor-installer-linux-deb.zip), [rpm](https://github.com/mfl28/BoundingBoxEditor/releases/download/v2.2.0/boundingboxeditor-portable-linux.zip) | [image]()|
43+
| macOS | [dmg](https://github.com/mfl28/BoundingBoxEditor/releases/download/v2.2.0/boundingboxeditor-installer-macos-dmg.zip) | [image](https://github.com/mfl28/BoundingBoxEditor/releases/download/v2.2.0/boundingboxeditor-portable-macos.zip) |
44+
| Windows | [exe](https://github.com/mfl28/BoundingBoxEditor/releases/download/v2.2.0/boundingboxeditor-installer-windows-exe.zip) | [image](https://github.com/mfl28/BoundingBoxEditor/releases/download/v2.2.0/boundingboxeditor-portable-windows.zip) |
4045

4146
> **Note for Linux users with Hi-DPI screens**
42-
> Currently JavaFX does not follow the system-wide scale settings in Linux (see e.g. bug reports [here](https://bugs.openjdk.java.net/browse/JDK-8248126) and [here](https://bugs.openjdk.java.net/browse/JDK-8238077)). The easiest way to set the desired scaling manually is by setting the `GDK_SCALE` variable when starting the application from the terminal, for example:
47+
> Currently JavaFX does not follow the system-wide scale settings in some Linux distributions (see e.g. bug reports [here](https://bugs.openjdk.java.net/browse/JDK-8248126) and [here](https://bugs.openjdk.java.net/browse/JDK-8238077)). The easiest way to set the desired scaling manually is by setting the `GDK_SCALE` variable when starting the application from the terminal, for example:
4348
> ```bash
44-
> GDK_SCALE=2x ./boundingboxeditor
49+
> GDK_SCALE=2x ./BoundingBoxEditor
4550
> ```
4651
## How to use the application
4752
Please refer to the [User Manual](https://github.com/mfl28/BoundingBoxEditor/wiki#user-manual) in the Wiki for a detailed usage guide and presentation (including gifs) of the application's main functions.

0 commit comments

Comments
 (0)