ramforth/video-converter
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Docs: Update all documentation to reflect current project state and future priorities

Browse Source
This commit is contained in:
Ramforth
2025-11-01 16:15:40 +01:00
parent be101e0869
commit 2846471d50
2 changed files with 39 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
USAGE.md
View File

@@ -38,17 +38,25 @@ Once the setup is complete, you can run the converter script or the packaged exe
### Running the Python Script
```bash
python -m src.main [path_to_your_input_video_file] [-o <path_to_output_directory>]
python main.py [path_to_your_input_video_file] [-u <video_url>] [-q <quality_profile>] [-o <path_to_output_directory>]
```
* Replace `[path_to_your_input_video_file]` with the absolute or relative path to the video file you want to convert. This argument is now optional.
* Replace `<path_to_output_directory>` with the desired directory for the converted file. If omitted, the converted file will be saved in the same directory as the input file.
* Use `-u <video_url>` to provide a URL for a video to download and convert. If both a file path and a URL are provided, the URL will be prioritized.
* Use `-q <quality_profile>` to select the output video quality. Available choices are `low`, `medium` (default), `high`, and `archive`. This controls the DNxHD/HR profile used for conversion, impacting file size and visual fidelity.
* Replace `<path_to_output_directory>` with the desired directory for the converted file. If omitted, the converted file will be saved in the same directory as the input file (or the downloaded file).
**Example (Interactive Input):**
```bash
python -m src.main
# Script will then prompt: Please enter the path to the input video file:
python main.py
# Script will then prompt: Please enter the path to the input video file or a URL:
```
**Example (Downloading and Converting from URL):**
```bash
python main.py -u "https://www.youtube.com/watch?v=dQw4w9WgXcQ" -q high -o /home/user/ConvertedVideos
```
### Running the Packaged Executable
@@ -61,14 +69,15 @@ After building the executable (see `DEVELOPMENT_PLAN.md` for details on packagin
```
2. **Run the executable:**
```bash
./video-converter [path_to_your_input_video_file] [-o <path_to_output_directory>]
./video-converter [path_to_your_input_video_file] [-u <video_url>] [-q <quality_profile>] [-o <path_to_output_directory>]
```
The usage is identical to the Python script, but you execute the binary directly.
**Example:**
```bash
./video-converter /home/user/Videos/my_original_video.mp4 -o /home/user/ConvertedVideos
./video-converter /home/user/Videos/my_original_video.mp4 -q low -o /home/user/ConvertedVideos
./video-converter -u "https://www.youtube.com/watch?v=dQw4w9WgXcQ" -q archive
```
## 4. What it Does