Skip to content

Commit de9db2e

Browse files
committed
Update README.md to clarify media path setup and environment variable usage
1 parent db0bf89 commit de9db2e

1 file changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,22 @@
5858
pip install -r requirements.txt
5959
```
6060

61-
4. **Run the application:**
61+
4. **Prepare media paths (pick one):**
62+
- **Default (repo-relative):** place photos in `input/photos/`, background track as `input/audio.mp3`, and ensure `output/` exists for the rendered video.
63+
- **Custom paths:** set env vars before running:
64+
```bash
65+
set PYMONTAGE_IMAGE_FOLDER="C:\path\to\photos" # Windows
66+
set PYMONTAGE_AUDIO_FILE="C:\path\to\music.mp3"
67+
set PYMONTAGE_OUTPUT_FILE="C:\path\to\slideshow.mp4"
68+
```
69+
(macOS/Linux: use `export VAR=value`)
70+
71+
5. **Run the application:**
6272
```bash
6373
python app.py
6474
```
6575

66-
5. **Open your browser:**
76+
6. **Open your browser:**
6777
Navigate to `http://127.0.0.1:5000`
6878

6979
## 📖 Usage
@@ -94,6 +104,10 @@
94104

95105
## ⚙️ Configuration Options
96106

107+
### Paths & environment variables
108+
- Default (repo-relative): images in `input/photos/`, audio in `input/audio.mp3`, output to `output/slideshow.mp4`.
109+
- Override for CI/servers by setting `PYMONTAGE_IMAGE_FOLDER`, `PYMONTAGE_AUDIO_FILE`, `PYMONTAGE_OUTPUT_FILE`.
110+
97111
### Basic Settings
98112
- **Intro Text**: Opening title displayed at the beginning
99113
- **Outro Text**: Closing title displayed at the end
@@ -145,9 +159,11 @@ PyMontage/
145159
├── templates/
146160
│ └── index.html # Web interface
147161
├── requirements.txt # Python dependencies
148-
├── README.md # This file
149-
├── temp_uploads/ # Temporary storage for uploaded files
150-
└── temp_outputs/ # Temporary storage for generated videos
162+
├── README.md # This file
163+
├── input/
164+
│ ├── photos/ # Default images location
165+
│ └── audio.mp3 # Default soundtrack
166+
└── output/ # Rendered videos (default target)
151167
```
152168
153169
### Supported Formats

0 commit comments

Comments
 (0)