Skip to content

Commit 0c2ed0b

Browse files
authored
Update README.md
1 parent eaddcf4 commit 0c2ed0b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# napari-deeplabcut
1+
# napari-deeplabcut: keypoint annotation for pose estimation
22

33

4-
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1d409ffe-c9f4-47e1-bde2-3010c1c40455/naparidlc.png?format=750w" width="250" title="napari-deeplabcut" alt="napari+deeplabcut" align="right" vspace = "80">
4+
5+
<img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1d409ffe-c9f4-47e1-bde2-3010c1c40455/naparidlc.png?format=750w" width="450" title="napari-deeplabcut" alt="napari+deeplabcut" align="right" vspace = "80">
6+
7+
[📚Documentation](https://deeplabcut.github.io/DeepLabCut/README.html) |
8+
[🛠️ DeepLabCut Installation](https://deeplabcut.github.io/DeepLabCut/docs/installation.html) |
9+
[🌎 Home Page](https://www.deeplabcut.org) |
510

611
[![License: BSD-3](https://img.shields.io/badge/License-BSD3-blue.svg)](https://www.gnu.org/licenses/bsd3)
712
[![PyPI](https://img.shields.io/pypi/v/napari-deeplabcut.svg?color=green)](https://pypi.org/project/napari-deeplabcut)
@@ -10,11 +15,13 @@
1015
[![codecov](https://codecov.io/gh/DeepLabCut/napari-deeplabcut/branch/main/graph/badge.svg)](https://codecov.io/gh/DeepLabCut/napari-deeplabcut)
1116
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-deeplabcut)](https://napari-hub.org/plugins/napari-deeplabcut)
1217

13-
A napari plugin for keypoint annotation with DeepLabCut
18+
A napari plugin for keypoint annotation, also used within DeepLabCut!
1419

1520

1621
## Installation
1722

23+
If you installed DeepLabCut[gui], this plugin is already installed. However, you can also use this as a stand-alone keypoint annotator without using DeepLabCut. Instructions below!
24+
1825
Start by installing PySide6 with `pip install "pyside6<6.3.2"`; this is the library we now use to build GUIs.
1926

2027
You can then install `napari-deeplabcut` via [pip]:
@@ -195,7 +202,7 @@ If you encounter any problems, please [file an issue] along with a detailed desc
195202
## Acknowledgements
196203

197204

198-
This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template. We thank the Chan Zuckerberg Initiative (CZI) for funding this work!
205+
This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template. We thank the Chan Zuckerberg Initiative (CZI) for funding the initial development of this work!
199206

200207
<!--
201208
Don't miss the full getting started guide to set up your new package:

0 commit comments

Comments
 (0)