README update
This commit is contained in:
parent
ebcc74fb2a
commit
abd46181eb
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
|
@ -1,5 +1,13 @@
|
||||||
# VideoPress — FFmpeg Video Compressor
|
# VideoPress — FFmpeg Video Compressor
|
||||||
|
|
||||||
|
NOTE: This application was built with the help of AI.
|
||||||
|
|
||||||
|
- [x] The application code has been reviewed by this developer.
|
||||||
|
- [x] The application code has been tested by this developer.
|
||||||
|
|
||||||
|
If you find any issues, please feel free to post an issue, and / or a pull request for a fix.
|
||||||
|
|
||||||
|
## What is VideoPress?
|
||||||
A web-based video compression tool served via **Gunicorn + gevent** (WSGI),
|
A web-based video compression tool served via **Gunicorn + gevent** (WSGI),
|
||||||
containerised with **Docker**. FFmpeg compresses video files to approximately
|
containerised with **Docker**. FFmpeg compresses video files to approximately
|
||||||
1/3 their original size. All file-system access is restricted to a single
|
1/3 their original size. All file-system access is restricted to a single
|
||||||
|
|
@ -46,6 +54,12 @@ docker compose up -d
|
||||||
| pip packages | see requirements.txt |
|
| pip packages | see requirements.txt |
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Create a python virtual environment to run in
|
||||||
|
python3 -m venv videopress
|
||||||
|
|
||||||
|
#start the virtual environment
|
||||||
|
source ./videopress/bin/activate
|
||||||
|
|
||||||
# Install Python dependencies
|
# Install Python dependencies
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue