README update for PySide6 version#50
Conversation
Major rewrite of README to reflect the new PySide6-based DeepLabCut-Live-GUI. Updates include renamed project header and badges, updated license badge, new system requirements, detailed installation instructions (uv and conda/mamba workflows), run instructions, and a concise typical workflow (multi-camera preview, inference, and recording). Notes added about current limitations, references/citation, and contribution/feedback guidance; legacy tkinter-focused guidance and some older UI walkthrough text were removed or replaced with modernized guidance.
C-Achard
added
documentation
There was a problem hiding this comment.
Pull request overview
This pull request updates the README to reflect the modernized PySide6-based GUI introduced in PR #35 and refined in PR #38. The update transforms a detailed technical README into a concise, user-friendly quick-start guide that focuses on installation and basic workflows, while technical details have been moved to the docs/ folder.
Changes:
- Replaced comprehensive technical documentation with streamlined installation and getting-started guide
- Added support for both
uvandcondainstallation workflows with inference backend selection - Updated to reflect PySide6 (Qt) interface with multi-camera support replacing tkinter
- Corrected license reference (removed incorrect "Lesser" GPL claim, letting LICENSE file be authoritative)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
deruyter92
left a comment
deruyter92
left a comment
There was a problem hiding this comment.
Looks fine. Would only invert the order between cloning and installing.
Also: there is currently no reference for people who want to install from PyPI in in their (globally available) conda env instead of cloning & installing in their uv venv, but I'll leave it up to you if you want to include this.
Feel free to merge once you think it's ready!
Rework and clarify installation steps in README.md: add a top-level "Clone the repository" step, consolidate and renumber environment/setup steps, and remove duplicated clone instructions. Move and clarify Windows activation commands, ensure guidance for running the app references conda/uv usage, and add TIP/IMPORTANT/NOTE callouts for GPU/CUDA compatibility and environment activation. Minor formatting and ordering fixes to make the installation flow easier to follow.
Thanks ! Indeed I am waiting for the PyPi release to update docs and README. Ideally this would all be done in a dedicated versioning PR. |
2 participants
Updates the previous README to reflect the new version of the GUI introduced in #35 and polished in #38.