diff --git a/README.md b/README.md index 847f55c..3b9c50c 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,29 @@ recommended this to me. However, my pyinstaller build did not work. :( HELP ## Building with nix `nix-build` to get a script with all the libraries and ffmpeg, `nix-build -A bundle` to get a single binary. + +## Install & run + +#### With executeable + +- Download & extract [jumpcutter.zip](https://github.com/carykh/jumpcutter/files/3964820/jumpcutter.zip) +- Open `cmd` +- Run `C:\YOUR/PATH\jumpcutter.exe --input_file C:\YOUR\FILE.mp4 --sounded_speed 1 --silent_speed 99999 --frame_margin 2` + +#### With python + +- Open cmd/terminal, and `cd` to the jumpcutter folder. +- 'pip install -r requirements.txt' +- Run: `python jumpcutter.py --input_file C:\YOUR\FILE.mp4 --sounded_speed 1 --silent_speed 99999 --frame_margin 2` + +#### Install ffmpeg + +If you have no ffmpeg installed, follow these steps: + +##### Linux + +`sudo apt-get install ffmpeg` + +##### Windows + +[Read this guide](https://windowsloop.com/install-ffmpeg-windows-10/) \ No newline at end of file