Updated readme to include build command
This commit is contained in:
parent
80cded98c6
commit
ea79ef97fc
48
README.md
48
README.md
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Transform any audio file into stunning oscilloscope visualizations. Supports massive files with zero memory issues.
|
Transform any audio file into stunning oscilloscope visualizations. Supports massive files with zero memory issues.
|
||||||
|
|
||||||
 
|

|
||||||
|
|
||||||
## ✨ Key Features
|
## ✨ Key Features
|
||||||
|
|
||||||
@ -15,17 +15,47 @@ Transform any audio file into stunning oscilloscope visualizations. Supports mas
|
|||||||
|
|
||||||
## 🚀 Quick Start
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
### 1. Install System Dependencies
|
||||||
|
|
||||||
|
**Ubuntu/Debian:**
|
||||||
```bash
|
```bash
|
||||||
# Install dependencies
|
sudo apt update && sudo apt install ffmpeg
|
||||||
sudo apt install ffmpeg # Ubuntu/Debian
|
```
|
||||||
# or
|
|
||||||
brew install ffmpeg # macOS
|
|
||||||
|
|
||||||
# Build and install
|
**macOS:**
|
||||||
cargo install --git https://github.com/yourusername/oscilloscope-video-gen
|
```bash
|
||||||
|
brew install ffmpeg
|
||||||
|
```
|
||||||
|
|
||||||
# Generate video
|
**Windows:**
|
||||||
oscilloscope-video-gen -i your_music.flac -o oscilloscope.mp4
|
```bash
|
||||||
|
# Via winget (recommended)
|
||||||
|
winget install ffmpeg
|
||||||
|
|
||||||
|
# Or download from https://ffmpeg.org/download.html
|
||||||
|
# Make sure ffmpeg is in your PATH
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Build the Project
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# If you have the source code locally:
|
||||||
|
cd /path/to/oscilloscope-video-gen
|
||||||
|
|
||||||
|
# Build in release mode (much faster)
|
||||||
|
cargo build --release
|
||||||
|
|
||||||
|
# The binary will be at: target/release/oscilloscope-video-gen
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Generate Your First Video
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Basic usage - replace 'audio.wav' with your audio file
|
||||||
|
./target/release/oscilloscope-video-gen -i audio.wav -o oscilloscope.mp4
|
||||||
|
|
||||||
|
# Check available options
|
||||||
|
./target/release/oscilloscope-video-gen --help
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🎮 Usage Examples
|
## 🎮 Usage Examples
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user