From 8d55b00eb4e48c1aadaa9eb3b5e8b430f8d3508c Mon Sep 17 00:00:00 2001 From: sumn2u Date: Sun, 14 Jul 2024 16:24:03 -0500 Subject: [PATCH 1/4] fix image design in readme --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 54 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e4a9a5f..8ec1430 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,45 @@ -
- -# Annotate-Lab - -Annotate-Lab is an open-source application designed for image annotation, comprising two main components: the client and the server. The client, a React application, is responsible for the user interface where users perform annotations. On the other hand, the server, a Flask application, manages persisting the annotated changes and generating masked and annotated images, along with configuration settings. More information can be found in our [documentation](https://annotate-docs.dwaste.live/). - -[![Open Source Helpers](https://www.codetriage.com/sumn2u/annotate-lab/badges/users.svg)](https://www.codetriage.com/sumn2u/annotate-lab) -[![Test Workflow](https://github.com/sumn2u/annotate-lab/actions/workflows/python-app.yml/badge.svg)](https://github.com/sumn2u/annotate-lab/actions) -[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9112/badge)](https://www.bestpractices.dev/projects/9112) -[![Test Workflow](https://github.com/sumn2u/annotate-lab/actions/workflows/vite-app.yml/badge.svg)](https://github.com/sumn2u/annotate-lab/actions) -[![GitHub issues](https://img.shields.io/github/issues/sumn2u/annotate-lab)](https://github.com/sumn2u/annotate-lab/issues) [![GitHub forks](https://img.shields.io/github/forks/sumn2u/annotate-lab)](https://github.com/sumn2u/annotate-lab/network) -[![GitHub stars](https://img.shields.io/github/stars/sumn2u/annotate-lab)](https://github.com/sumn2u/annotate-lab/stargazers) -[![GitHub license](https://img.shields.io/github/license/sumn2u/annotate-lab)](https://github.com/sumn2u/annotate-lab/blob/master/LICENSE) -[![Code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) - -
![example](./sample_images/example.png) +

Annotate Lab

+

+Annotate Lab is an open-source application designed for image annotation, comprising two main components: the client and the server. The client, a React application, is responsible for the user interface where users perform annotations. On the other hand, the server, a Flask application, manages persisting the annotated changes and generating masked and annotated images, along with configuration settings. More information can be found in our documentation. + +

+ +

+ + Open Source Helpers + + + Test Workflow + + + OpenSSF Best Practices + + + Test Workflow + + + GitHub issues + + + GitHub forks + + + GitHub stars + + + GitHub license + + + Code style: prettier + + + Code style: black + +

+
@@ -242,13 +264,25 @@ const config = { ``` ## Demo [V2.0](https://github.com/sumn2u/annotate-lab/releases/tag/2.0.0) -[![Annotate Lab](https://img.youtube.com/vi/iUI6MKWqCeg/0.jpg)](https://www.youtube.com/watch?v=iUI6MKWqCeg) +
+ + Annotate Lab + +
## Outputs [[documentation page]](https://annotate-docs.dwaste.live/fundamentals/set-up-and-run/outputs) Sample of annotated image along with its mask and settings is show below. -![orange_annotation](./sample_images/orange_annotated-image.png) -![orange_annotation_mask](./sample_images/orange_masked-image.png) +
+ orange_annotation + orange_annotation_mask +
+ +
+ Orange Annotation + Orange Annotation Mask +
+
```json { From 7485216d5063ca18cb25bf795d9f628eb7a03e9d Mon Sep 17 00:00:00 2001 From: sumn2u Date: Sun, 14 Jul 2024 16:25:41 -0500 Subject: [PATCH 2/4] fix design for demo and outputs --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8ec1430..8fe1965 100644 --- a/README.md +++ b/README.md @@ -264,24 +264,24 @@ const config = { ``` ## Demo [V2.0](https://github.com/sumn2u/annotate-lab/releases/tag/2.0.0) -
+

Annotate Lab -

+

## Outputs [[documentation page]](https://annotate-docs.dwaste.live/fundamentals/set-up-and-run/outputs) Sample of annotated image along with its mask and settings is show below. -
+

orange_annotation orange_annotation_mask -

+

-
+

Orange Annotation Orange Annotation Mask -

+


```json From c177bfaf58a56c5080609e641e62d4372857cfb4 Mon Sep 17 00:00:00 2001 From: sumn2u Date: Sun, 14 Jul 2024 16:27:49 -0500 Subject: [PATCH 3/4] align items to center --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8fe1965..0c3f275 100644 --- a/README.md +++ b/README.md @@ -264,7 +264,7 @@ const config = { ``` ## Demo [V2.0](https://github.com/sumn2u/annotate-lab/releases/tag/2.0.0) -

+

Annotate Lab @@ -273,12 +273,12 @@ const config = { ## Outputs [[documentation page]](https://annotate-docs.dwaste.live/fundamentals/set-up-and-run/outputs) Sample of annotated image along with its mask and settings is show below. -

+

orange_annotation orange_annotation_mask

-

+

Orange Annotation Orange Annotation Mask

From 9c2c73b3bd4522d7af4f923bf787bcee6f3a674c Mon Sep 17 00:00:00 2001 From: sumn2u Date: Sun, 14 Jul 2024 16:29:41 -0500 Subject: [PATCH 4/4] remove caption of annotated orange and its mask --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 0c3f275..ba5d1a8 100644 --- a/README.md +++ b/README.md @@ -278,10 +278,6 @@ Sample of annotated image along with its mask and settings is show below. orange_annotation_mask

-

- Orange Annotation - Orange Annotation Mask -


```json