Skip to content

Commit 803d3c9

Browse files
committed
Update README, add Sonarcloud quality gate badge.
1 parent 7287ccc commit 803d3c9

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88
![Azure DevOps tests (master)](https://img.shields.io/azure-devops/tests/mfl28/BoundingBoxEditor/1/master)
99
![Azure DevOps coverage (master)](https://img.shields.io/azure-devops/coverage/mfl28/BoundingBoxEditor/1/master)
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+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mfl28_BoundingBoxEditor&metric=alert_status)](https://sonarcloud.io/dashboard?id=mfl28_BoundingBoxEditor)
12+
1113

1214
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.
13-
Annotations can be imported and saved from/to [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) format xml-files or [YOLO](https://pjreddie.com/darknet/yolo/) format txt-files.
15+
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.
1416

1517
<p align="center">
1618
<img src="demo-media/demo_v2_0_0.png" align="center">
@@ -20,7 +22,7 @@ Annotations can be imported and saved from/to [Pascal VOC](http://host.robots.ox
2022

2123
## Main Features
2224
* Create rectangular and polygonal bounding box annotations for objects in images
23-
* Export and import (e.g. from [Pascal VOC 2012 dataset](http://host.robots.ox.ac.uk/pascal/VOC/voc2012/index.html)) rectangular and polygonal bounding box annotations using the [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) format
25+
* Export and import rectangular and polygonal bounding box annotations to and from JSON and XML files (using [Pascal VOC](http://host.robots.ox.ac.uk/pascal/VOC/) format)
2426
* Export and import rectangular bounding box annotations using the [YOLO](https://pjreddie.com/darknet/yolo/) format
2527
* Format validation and error reporting when importing annotations
2628
* Nest bounding box labels (which is then reflected in the output xml-file if using Pascal VOC format)
@@ -100,13 +102,14 @@ docker container cp bbeditor:/image .
100102
* [OpenJFX](https://openjfx.io/) (open-source implementation of the JavaFX platform)
101103
* [ControlsFX](https://github.com/controlsfx/controlsfx) (used for progress dialogs)
102104
* [Caffeine](https://github.com/ben-manes/caffeine) (used for caching of images)
105+
* [Gson](https://github.com/google/gson) (used for JSON serialization & deserialization)
103106
* [Apache Commons](https://commons.apache.org/) (used for ListOrderedMap data structure and String/Iterator utilities)
104107
* [TestFX](https://github.com/TestFX/TestFX) (used for the tests)
105108
* [JUnit 5](https://junit.org/junit5/) (used for the tests)
106109
* [Jacoco](https://www.jacoco.org/jacoco/) (used for creating code coverage results)
107110
* [LibSass Gradle Plugin](https://github.com/fgiannesini/LibSassGradlePlugin) (used to compile .scss style-files into [JavaFX supported] .css files)
108111
* [Badass JLink Plugin](https://github.com/beryx/badass-jlink-plugin) (used to create modular runtime images of the application)
109-
* [Gradle Modules Plugin](https://github.com/java9-modularity/gradle-modules-plugin) (used to run the tests on the classpath)
112+
* [Gradle Modules Plugin](https://github.com/java9-moduqlarity/gradle-modules-plugin) (used to run the tests on the classpath)
110113
* [Feather Icons](https://feathericons.com/)
111114
* [Nord Color-Palette](https://github.com/arcticicestudio/nord)
112115
* [Unsplash](https://unsplash.com/) (used as source for test- & demo-images)

0 commit comments

Comments
 (0)