From ea79ef97fc5341a5987fc578e3bbf26ed882d4e4 Mon Sep 17 00:00:00 2001 From: JorySeverijnse Date: Mon, 19 Jan 2026 01:04:37 +0100 Subject: [PATCH] Updated readme to include build command --- README.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 791d8d8..cf4f8ea 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Transform any audio file into stunning oscilloscope visualizations. Supports massive files with zero memory issues. -![Demo](https://img.shields.io/badge/demo-coming%20soon-blue) ![License](https://img.shields.io/badge/license-AGPL--3.0--or--later-green) +![License](https://img.shields.io/badge/license-AGPL--3.0--or--later-green) ## ✨ Key Features @@ -15,17 +15,47 @@ Transform any audio file into stunning oscilloscope visualizations. Supports mas ## 🚀 Quick Start +### 1. Install System Dependencies + +**Ubuntu/Debian:** ```bash -# Install dependencies -sudo apt install ffmpeg # Ubuntu/Debian -# or -brew install ffmpeg # macOS +sudo apt update && sudo apt install ffmpeg +``` -# Build and install -cargo install --git https://github.com/yourusername/oscilloscope-video-gen +**macOS:** +```bash +brew install ffmpeg +``` -# Generate video -oscilloscope-video-gen -i your_music.flac -o oscilloscope.mp4 +**Windows:** +```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