litruv/AudioSort
1
0
Fork 0
mirror of https://github.com/litruv/AudioSort.git synced 2026-07-24 18:56:01 +10:00
Code Issues Packages Projects Releases Wiki Activity

Enhance Installation documentation: Add Linux setup instructions,

Litruv
2025-11-12 08:20:02 +11:00
parent a05bf0aa39
commit 57e5de7cb0
1 changed files with 32 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
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 ## 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 * 4 GB of RAM or more
* Around 500 MB free for the app itself, plus space for your audio library * Around 500 MB free for the app itself, plus space for your audio library
* WAV files (16/24-bit PCM recommended) * WAV files (16/24-bit PCM recommended)
## Windows Setup ## 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. 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) ![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 ## Updating
* You can install new versions right over the top of the old one — your settings and library data will stay safe. * 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 ## 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 # clone the repo
git clone https://github.com/litruv/AudioSort.git git clone https://github.com/litruv/AudioSort.git
cd AudioSort cd AudioSort
# install dependencies # install dependencies
yarn install # or npm install npm install
# start the dev build # start the dev build
npm run dev npm run dev