Skip to content

Commit 223374e

Browse files
committed
Update README with installer details and build instructions
Expanded the Windows installation section to highlight the new FFmpeg Installer GUI, including features, usage, and requirements. Added a new section on building from source with prerequisites and build steps. Updated troubleshooting and contributing sections for clarity and completeness.
1 parent 07247cc commit 223374e

File tree

1 file changed

+61
-25
lines changed

1 file changed

+61
-25
lines changed

README.md

Lines changed: 61 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,43 +7,51 @@ A comprehensive guide and automation scripts for installing FFmpeg across multip
77
## Table of Contents
88
- [Features](#features)
99
- [Windows Installation](#windows-installation)
10-
- [Automated Installation](#automated-installation)
10+
- [Automated Installation (Recommended)](#automated-installation-recommended)
1111
- [Manual Installation](#manual-installation)
1212
- [macOS Installation](#macos-installation)
1313
- [Linux Installation](#linux-installation)
1414
- [Verification](#verification)
15-
- [Troubleshooting](#troubleshooting)
15+
- [Building from Source](#building-from-source)
1616
- [Contributing](#contributing)
1717
- [License](#license)
1818

1919
## Features
20-
- Automated installation scripts for Windows
20+
- **Modern GUI installer for Windows** with automatic updates
2121
- Cross-platform installation guides
2222
- Video tutorials for Windows and macOS
2323
- Multiple installation methods for each operating system
2424
- System path configuration included
25+
- Real-time download progress and hash verification
2526

2627
## Windows Installation
2728

28-
### Automated Installation
29+
### Automated Installation (Recommended)
2930

30-
#### Method 1: Using 7-Zip (Recommended)
31-
**Prerequisites:**
32-
- 7-Zip, WinRAR, or any 7-Zip fork installed
31+
#### FFmpeg Installer GUI
32+
**The easiest way to install FFmpeg on Windows**
3333

34-
**Steps:**
35-
1. Download [`install_ffmpeg_7z.bat`](https://github.com/oop7/ffmpeg-install-guide/releases/download/v1.0/ffmpeg_7z.bat)
36-
2. Run the script as administrator (UAC prompt will appear)
37-
3. Wait for the installation to complete
34+
![FFmpeg Installer Screenshot](screenshots/ffmpeg-installer-main.png)
3835

39-
#### Method 2: Using ZIP (No Dependencies)
40-
**Prerequisites:**
41-
- None (uses built-in Windows tools)
36+
**Features:**
37+
- Clean, modern Windows Forms interface
38+
- Real-time download progress with speed indicator
39+
- Automatic file integrity verification (SHA256)
40+
- System PATH configuration
41+
- Administrator privilege handling
42+
- Built-in update checker
43+
- Multiple extraction methods (portable 7z, COM objects, ZIP)
4244

43-
**Steps:**
44-
1. Download [`install_ffmpeg_zip.bat`](https://github.com/oop7/ffmpeg-install-guide/releases/download/v1.0/ffmpeg_zip.bat)
45-
2. Run the script as administrator (UAC prompt will appear)
46-
3. Wait for the installation to complete
45+
**Download & Usage:**
46+
1. Download the latest [`FFmpegInstaller.exe`](https://github.com/oop7/ffmpeg-install-guide/releases/latest) from releases
47+
2. Run as administrator (UAC prompt will appear automatically)
48+
3. Click "Install FFmpeg" and wait for completion
49+
4. Restart your command prompt to use `ffmpeg`
50+
51+
**Version:** 2.0.0
52+
**Developer:** oop7
53+
**Source Code:** Available in this repository
54+
**Requirements:** .NET 6.0 Runtime (usually pre-installed on Windows 10/11)
4755

4856
### Manual Installation
4957
1. Download FFmpeg from one of these sources:
@@ -118,25 +126,53 @@ After installation, verify FFmpeg is correctly installed:
118126
ffmpeg -version
119127
```
120128

121-
## Troubleshooting
129+
## Building from Source
130+
131+
### Prerequisites
132+
- .NET 6.0 SDK or later
133+
- Windows 10/11
134+
- Visual Studio 2022 or VS Code (optional)
135+
136+
### Build Instructions
137+
```powershell
138+
# Clone the repository
139+
git clone https://github.com/oop7/ffmpeg-install-guide.git
140+
cd ffmpeg-install-guide
141+
142+
# Build the application
143+
dotnet publish FFmpegInstaller.csproj -c Release -p:PublishSingleFile=true --output ./publish
144+
145+
# The executable will be in the ./publish directory
146+
```
147+
148+
### Development
149+
```powershell
150+
# Run in development mode
151+
dotnet run --project FFmpegInstaller.csproj
152+
153+
# Or open in Visual Studio
154+
start FFmpegInstaller.sln
155+
```
122156

123157
### Common Issues
124158
1. **Windows Path Not Updated:**
159+
- Restart your command prompt
125160
- Log out and log back in
126161
- Or restart your computer
127162

128163
2. **Permission Denied:**
129-
- Ensure you're running scripts as administrator
130-
- Check file permissions
164+
- Ensure you're running as administrator
165+
- Check antivirus software blocking the installation
131166

132-
3. **Installation Failed:**
133-
- Try the alternative installation method
134-
- Check your internet connection
135-
- Verify system requirements
167+
3. **FFmpeg command not found after installation:**
168+
- Restart command prompt/PowerShell
169+
- Check if PATH was updated: `echo $env:PATH` (PowerShell) or `echo %PATH%` (CMD)
170+
- Manually add to PATH if needed
136171

137172
## Contributing
138173
Contributions are welcome! Please feel free to submit a Pull Request.
139174

175+
### How to Contribute:
140176
1. Fork the repository
141177
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
142178
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)

0 commit comments

Comments
 (0)