Skip to content

Commit 19b286b

Browse files
committed
Update README.md
1 parent df40496 commit 19b286b

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
[![Code style:Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
5-
![PyPI - Python Version](https://img.shields.io/pypi/v/deeplabcut-live-gui)
5+
![PyPI - Package Version](https://img.shields.io/pypi/v/deeplabcut-live-gui)
66
![PyPI - Downloads](https://img.shields.io/pypi/dm/deeplabcut-live-gui?color=purple)
77
![Python versions](https://img.shields.io/pypi/pyversions/deeplabcut-live-gui)
88
<!-- ![Python package](https://github.com/DeepLabCut/DeepLabCut-live/workflows/Python%20package/badge.svg) -->
@@ -22,7 +22,7 @@ GUI to run [DeepLabCut-Live](https://github.com/DeepLabCut/DeepLabCut-live) on a
2222

2323
## Documentation
2424

25-
> Full documentations is a work in progress and will be posted to DeepLabCut's official docs site when ready.
25+
> Full documentation is a work in progress and will be posted to DeepLabCut's official docs site when ready.
2626
2727
---
2828

@@ -31,15 +31,16 @@ GUI to run [DeepLabCut-Live](https://github.com/DeepLabCut/DeepLabCut-live) on a
3131
- **Python 3.10, 3.11 or 3.12**
3232
- One inference backend (choose at least one):
3333
- **PyTorch** *(recommended for best performance & compatibility)*
34-
- **TensorFlow** *(for backwards compatibility with existing models; Windows limitation applies for Python > 3.10)*
34+
- **TensorFlow** *(for backwards compatibility with existing models; Windows installs are no longer available for Python > 3.10)*
3535
- A supported camera backend (OpenCV webcams by default; additional backends supported)
3636

3737
---
3838

3939
## Installation
4040

41-
This project is currently installed **from source** (editable install).
42-
The newest GUI and features may not yet be available on PyPI.
41+
While `deeplabcut-live-gui` is available on **PyPI**, the newest PySide6-based GUI and features are currently best obtained by installing from source.
42+
43+
To get the **latest version**, please follow the **instructions below**.
4344

4445
### Option A — Install with `uv`
4546

@@ -146,8 +147,8 @@ Typical workflow:
146147
- Record video and timestamps to organized session folders
147148

148149
> **Note:** OpenCV-compatible cameras (USB webcams, OBS virtual camera) work out of the box.
149-
> For additional camera ecosystems (Basler, GenTL, Aravis, etc.), see the camera backend docs.
150-
150+
> For additional camera ecosystems (Basler, GenTL, Aravis, etc.), see the relevant documentation.
151+
<!-- TODO @C-Achard add link to docs website once available -->
151152
152153
---
153154

0 commit comments

Comments
 (0)