Skip to content

Commit b7d75ce

Browse files
authored
Add docs link to README (#63)
* Remove outdated docs * Add link to docs website * Remove separators in README
1 parent 0d8507b commit b7d75ce

File tree

7 files changed

+2
-1387
lines changed

7 files changed

+2
-1387
lines changed

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,9 @@ The GUI has been modernized and is now built with **PySide6 (Qt)** (replacing tk
2020

2121
The new interface supports **multi-camera preview** with a **tiled display**, PyTorch models, and features improved interactive workflows for experimental use.
2222

23-
---
24-
2523
## Documentation
2624

27-
> Full documentation is a work in progress and will be posted to DeepLabCut's official docs site when ready.
28-
29-
---
25+
> Find the full documentation at the [DeepLabCut docs website](https://deeplabcut.github.io/DeepLabCut/docs/dlc-live/dlc-live-gui/index.html)
3026
3127
## System requirements (quick summary)
3228

@@ -36,8 +32,6 @@ The new interface supports **multi-camera preview** with a **tiled display**, Py
3632
- **TensorFlow** *(for backwards compatibility with existing models; Windows installs are no longer available for Python > 3.10)*
3733
- A supported camera backend (OpenCV webcams by default; additional backends supported)
3834

39-
---
40-
4135
## Installation
4236

4337
While the previous `deeplabcut-live-gui` is available on PyPI, the newest PySide6-based GUI and features **must be obtained by installing from source**.
@@ -109,8 +103,6 @@ pip install -e .[pytorch]
109103
pip install -e .[tf]
110104
```
111105

112-
---
113-
114106
## Run the application
115107

116108
> [!TIP]
@@ -128,8 +120,6 @@ uv run dlclivegui
128120
> [!IMPORTANT]
129121
> Activate your venv/conda environment before launching so the GUI can access installed dependencies.
130122
131-
---
132-
133123
## Typical workflow
134124

135125
The new GUI supports **one or more cameras**.
@@ -152,8 +142,6 @@ Typical workflow:
152142
> For additional camera ecosystems (Basler, GenTL, Aravis, etc.), see the relevant documentation.
153143
<!-- TODO @C-Achard add link to docs website once available -->
154144
155-
---
156-
157145
## Current limitations
158146

159147
- Pose inference runs on **one selected camera at a time** (even in multi-camera mode)
@@ -177,4 +165,4 @@ If you use this code, we kindly ask you to please cite:
177165

178166
This project is under active development — feedback from real experimental use is highly valued.
179167

180-
Please report issues, suggest features, or contribute on [GitHub](https://github.com/DeepLabCut/DeepLabCut-live-GUI).
168+
Please report issues, suggest features, or contribute here on [GitHub](https://github.com/DeepLabCut/DeepLabCut-live-GUI/issues).

docs/README.md

Lines changed: 0 additions & 261 deletions
This file was deleted.

0 commit comments

Comments
 (0)