Skip to content

Commit 2d00d64

Browse files
committed
docs: clarify source install flow and planned PyPI install
1 parent 890e68c commit 2d00d64

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,21 @@ img-timeline build ./rainbow ./rainbow_timeline.tif
2929

3030
## Install
3131

32-
### Recommended (virtual environment)
32+
### From source (current method)
33+
34+
First, download the repository:
35+
36+
```bash
37+
git clone https://github.com/aelder/image_processing.git
38+
cd image_processing
39+
```
40+
41+
Then install in a virtual environment:
3342

3443
```bash
3544
python3 -m venv .venv
3645
source .venv/bin/activate
37-
pip install -e .[progress]
46+
pip install -e ".[progress]"
3847
```
3948

4049
### Command installed
@@ -43,6 +52,14 @@ pip install -e .[progress]
4352
img-timeline
4453
```
4554

55+
### Planned PyPI install
56+
57+
Once published to PyPI, install without cloning:
58+
59+
```bash
60+
pip install movie-color-timeline
61+
```
62+
4663
## Quickstart (60 seconds)
4764

4865
1. Put movie frames (`.tif` / `.tiff`) in a folder, e.g. `./frames`.

0 commit comments

Comments
 (0)