From 57e5de7cb03db5798dfc3ab4fc30e5ed1dfeef71 Mon Sep 17 00:00:00 2001 From: Max Litruv Boonzaayer Date: Wed, 12 Nov 2025 08:20:02 +1100 Subject: [PATCH] Enhance Installation documentation: Add Linux setup instructions, --- Installation.md | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/Installation.md b/Installation.md index bfb0713..f6b17bc 100644 --- a/Installation.md +++ b/Installation.md @@ -1,20 +1,45 @@ -AudioSort runs as a desktop app built with Electron. Follow the steps below to get it up and running on your machine. +AudioSort runs as a cross-platform desktop app built with Electron. Follow the steps below to get it up and running on your machine. ## System Requirements -* Windows 10 or newer (64-bit) +* **Windows**: Windows 10 or newer (64-bit) +* **Linux**: Any modern distribution (Ubuntu 20.04+, Fedora 35+, etc.) * 4 GB of RAM or more * Around 500 MB free for the app itself, plus space for your audio library * WAV files (16/24-bit PCM recommended) ## Windows Setup -1. Download the latest `AudioSort Setup` installer from the releases page. +1. Download the latest `AudioSort Setup.exe` installer from the [releases page](https://github.com/litruv/AudioSort/releases). 2. Run it and follow the prompts — you can pick a custom install location if you want. -3. Once it’s done, launch AudioSort from the Start Menu or the desktop shortcut. +3. Once it's done, launch AudioSort from the Start Menu or the desktop shortcut. ![Installer completion](assets/installer-finish.png) +## Linux Setup + +AudioSort is available in multiple formats for Linux: + +### AppImage (Universal) +Works on any Linux distribution without installation: + +```bash +# Download from releases page +chmod +x AudioSort-*.AppImage +./AudioSort-*.AppImage +``` + +### Debian/Ubuntu (.deb) +```bash +sudo dpkg -i audio-sort_*.deb +sudo apt-get install -f # Install dependencies if needed +``` + +### Fedora/RHEL (.rpm) +```bash +sudo dnf install ./audio-sort-*.rpm +``` + ## Updating * You can install new versions right over the top of the old one — your settings and library data will stay safe. @@ -22,15 +47,15 @@ AudioSort runs as a desktop app built with Electron. Follow the steps below to g ## Development Builds -If you’re contributing or just want to run from source: +If you're contributing or just want to run from source: -```powershell +```bash # clone the repo git clone https://github.com/litruv/AudioSort.git cd AudioSort # install dependencies -yarn install # or npm install +npm install # start the dev build npm run dev