Upload README.md

README.md

@@ -1,52 +1,76 @@
+---
+hello:
+---
 <div align="center">
 <article style="display: flex; flex-direction: column; align-items: center; justify-content: center;">
-    <p align="center"><img width="300" src="https://github.com/opendatalab/labelU/blob/main/images/labelU-logo.svg" /></p>
+    <p align="center"><img width="300" src="https://user-images.githubusercontent.com/25022954/209616423-9ab056be-5d62-4eeb-b91d-3b20f64cfcf8.svg" /></p>
     <h1 style="width: 100%; text-align: center;"></h1>
     </p>
 </article>
 
 <a href="./README_zh-CN.md" >简体中文</a> | English
 
-<p align="center">
-<img style="width: 700px" src="./docs/assets/main.png">
-</p>
 
 </div>
 
 ## Introduction
 
-LabelU is an open source data annotation tool that supports Chinese. At present, it has image annotation capabilities such as rectangle, polygon, point, line, classification, description. It can support detection, classification, segmentation, text transcription, Line detection, key point detection and other computer vision task scenarios. You can customize the annotation task by freely combining tools, and support COCO and MASK format data export.
+LabelU is an open source data annotation tool that supports Chinese. At present, it has image annotation capabilities such as rectangle, polygon, point, line, classification, and caption. It can support detection, classification, segmentation, text transcription, Line detection, key point detection and other computer vision task scenarios. You can customize the annotation task by freely combining tools, and support COCO and MASK format data export.
 
 ## Getting started
 
-### Download and Install miniconda
-
-https://docs.conda.io/en/latest/miniconda.html
+### Install locally with miniconda
+```
+# Download and Install miniconda
+# https://docs.conda.io/en/latest/miniconda.html
 
-### Create and activate virtual environment(python = 3.10)
+# Create virtual environment(python = 3.7)
+conda create -n labelu python=3.7
 
-```bash
-conda create -n labelu --python=3.10
+# Activate virtual environment
 conda activate labelu
-```
-
-### Install labelu
 
-```bash
+# Install labelu
 pip install labelu
+
+# Start labelu, server: http://localhost:8000
+labelu
 ```
 
-### Start labelu，server：http://localhost:8000
+### Install for local development
+```
+# Download and Install miniconda
+# https://docs.conda.io/en/latest/miniconda.html
 
-```bash
-labelu
+# Create virtual environment(python = 3.7)
+conda create -n labelu python=3.7
+
+# Activate virtual environment
+conda activate labelu
+
+# Install peotry
+# https://python-poetry.org/docs/#installing-with-the-official-installer
+
+# Install all package dependencies
+poetry install
+
+# Start labelu, server: http://localhost:8000
+uvicorn labelu.main:app --reload
+
+# Update submodule
+git submodule update --remote --merge
 ```
 
 ## feature
 
-- Uniform，Six image annotation tools are provided, which can be configured through simple visualization or Yaml
-- Unlimited，Multiple tools can be freely combined to meet most image annotation requirements
-- Universal，Support multiple data export formats, including LabelU, COCO, Mask
+- Uniform, Six image annotation tools are provided, which can be configured through simple visualization or Yaml
+- Unlimited, Multiple tools can be freely combined to meet most image annotation requirements
+
+<p align="center">
+<img style="width: 600px" src="https://user-images.githubusercontent.com/25022954/209318236-79d3a5c3-2700-46c3-b59a-62d9c132a6c3.gif">
+</p>
+
+- Universal, Support multiple data export formats, including LabelU, COCO, Mask
 
 ## Scenes
 
@@ -61,19 +85,25 @@ labelu
 
 ## Usage
 
--  [Guide](./docs/README.md) 
+-  [Guide](./docs/GUIDE.md) 
 
 ## Annotation Format
 
-[LabelU Annotation Format](./docs/annotation/README.md)
+-  [LabelU Annotation Format](./docs/annotation%20format/README.md)
 
 ## Communication
 
-![8faa20cf-6898-4b16-b4cc-174795159f2c](https://user-images.githubusercontent.com/25022954/208056526-bc2de8b9-f5c5-4095-9e97-a2bf1b08bd1b.jpg)
+Welcome to the Opendatalab Wechat group!
+
+<p align="center">
+<img style="width: 400px" src="https://user-images.githubusercontent.com/25022954/208374419-2dffb701-321a-4091-944d-5d913de79a15.jpg">
+</p>
+
+
 
 ## Links
 
-- [labelU-Kit](https://github.com/opendatalab/labelU-Kit)（Powered by labelU-Kit）
+- [labelU-Kit](https://github.com/opendatalab/labelU-Kit)(Powered by labelU-Kit)
 
 ## LICENSE