Skip to content

Commit 04b313e

Browse files
committed
readme
1 parent 86f15ee commit 04b313e

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It works using Two-pass encoding and FFMPEG for video encoding.
1111
- Multiple app themes available (depending on what's on your os)
1212
- Settings are saved between sessions
1313
- Only requires FFMPEG and FFPROBE to work (you can chose which version to use)
14-
## How it works
14+
## How to use
1515

1616
- Select all of your videos from your file explorer
1717
- Set your desired size
@@ -23,5 +23,17 @@ It works using Two-pass encoding and FFMPEG for video encoding.
2323
[![App preview](https://github.com/MathMot/GuiVideoCompressor/blob/master/resources/preview/GuiVideoCompressorPreview.png?raw=true)]()
2424

2525
## Installation
26+
### Windows :
27+
- Download GuiVideoCompressor-Windows.rar
28+
- If you don't have FFMPEG or FFPROBE installed, you can download them from the release file Dependencies-Windows.rar (or via the official ffmpeg website)
29+
- Extract 'GuiVideoCompressor-Windows.rar' and open the file 'start.bat' (you can also use the .exe in the App folder, the bat is just here so that it's easier to open)
30+
- If you need to setup ffmpeg/ffprobe, extract 'Dependencies-Windows.rar' and place them in the deps folder of the application.
31+
- Once started, on the bottom left, the app will say if the dependencies are loaded, you can press the "Open Dependencies Settings" button to get more information if needed
2632

27-
- Download the corresponding
33+
### Linux :
34+
- Download GuiVideoCompressor-Linux.rar
35+
- Start the AppImage located in the App folder
36+
- You need ffmpeg and ffprobe installed (either on your os or just directly in the deps folder)
37+
38+
### FFMPEG REQUIREMENTS
39+
- **FFMPEG needs to have the libx264 encoder otherwise it's not possible to compress your files using the Two-pass encoding, you can check if you have libx264 by typing 'ffmpeg -encoders'**

0 commit comments

Comments
 (0)