Skip to content

Commit 5f3670a

Browse files
authored
Merge pull request #310 from funkelab/update_readme
update README usage
2 parents 500d840 + 99d6490 commit 5f3670a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ for more details on the concepts and method.
1818
Users can download and install an executable application from the github release, or
1919
install from `pypi` in the environment of their choice (e.g. `venv`, `conda`) with the command
2020
`pip install motile-tracker`.
21-
Currently, the motile_tracker requires python >=3.10.
21+
Currently, the motile_tracker requires python >=3.11.
2222

2323
### Recommended extras
2424

@@ -51,9 +51,14 @@ pip install motile-tracker[gurobi13] # For Gurobi 13.x licenses
5151
Developers can clone the GitHub repository and then use `uv` to install and run the code.
5252
See the developer guide in `DEVELOPER.md` for more information.
5353

54-
## Running Motile Tracker
54+
## Usage
5555

56-
Start the executable application, or run `motile_tracker` from the command line.
56+
Start napari and call the main widget via Plugins > Motile > Motile Main Widget.
57+
2D+time and 3D+time sample data can be loaded via File > Open Sample > Motile. You can
58+
track objects in napari Labels or Points layers. For details, please read the
59+
[documentation](https://funkelab.github.io/motile_tracker/).
60+
61+
![motile_tracker_quick_demo](https://github.com/user-attachments/assets/07a4a954-3d2d-4d67-8f75-aec11ee14697)
5762

5863
## Package the application into an executable and create the installer
5964

0 commit comments

Comments
 (0)