Add comprehensive documentation for AudioSort including Home, Installation, FAQ, and Library Workflow

2025-11-11 11:20:26 +11:00
parent e609085708
commit 0ffb5e5036
4 changed files with 132 additions and 1 deletions

31
FAQ.md Normal file

@@ -0,0 +1,31 @@
# FAQ
## The app cant find my library path
Make sure the folders readable and youve got permission to create subfolders.
AudioSort stores its database under `%APPDATA%/AudioSort/` on Windows.
## My waveform preview looks flat
Waveform previews rebuild whenever files change. Try **Rescan Library** or tweak any bit of metadata to force a refresh.
If the files mostly silence, the flat preview might actually be accurate.
## Duplicate groups look wrong
Duplicate detection uses MD5 hashes of the raw audio data.
If two files sound the same but still dont match, double-check their sample rate and bit depth — or normalise them externally before importing.
## Organise File sent stuff to weird folders
The organiser bases folders on the first UCS category in the file.
Check your category assignments and make sure the UCS catalog entry matches where you want it to go.
## Can I use formats other than WAV?
Nope. AudioSorts pipeline is WAV-only so metadata stays consistent.
Convert other formats to WAV before adding them.
## Wheres the UCS catalog stored?
The app ships with `data/UCS.csv`.
On first run, it also copies that file into your user data directory for safe keeping.

26
Home.md

@@ -1 +1,25 @@
Welcome to the AudioSort wiki! # AudioSort Docs
Welcome to the AudioSort wiki. This is where youll find setup info, workflow notes, and fixes for when things go sideways. Its all built around the Electron app — your main tool for managing WAV libraries.
## Highlights
* **WAV-first setup** automatically scans and detects duplicates using checksums
* **UCS tag categories** full support with the built-in catalog
* **Waveform previews & splitting** edit and trim sounds right in the app
* **Smart search** fuzzy Fuse.js search with advanced metadata filters
## Quick Start
1. Download and install the desktop app ([Installation](Installation.md))
2. Launch AudioSort and choose your library folder
3. Run **Rescan Library** from the menu to import your WAVs
4. Use tags, categories, and sorting tools to keep things neat
## Navigation
* [Installation](Installation.md)
* [Library Workflow](Library-Workflow.md)
* [FAQ](FAQ.md)
Have an idea or found something that could be better? Open an issue or pull request in the main AudioSort repo.

39
Installation.md Normal file

@@ -0,0 +1,39 @@
# Installation
AudioSort runs as a 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)
* 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.
2. Run it and follow the prompts — you can pick a custom install location if you want.
3. Once its done, launch AudioSort from the Start Menu or the desktop shortcut.
## Updating
* You can install new versions right over the top of the old one — your settings and library data will stay safe.
* After updating, open the app and hit **Rescan Library** to keep everything in sync with your files.
## Development Builds
If youre contributing or just want to run from source:
```powershell
# clone the repo
git clone https://github.com/litruv/AudioSort.git
cd AudioSort
# install dependencies
yarn install # or npm install
# start the dev build
npm run dev
```
The dev script spins up Vite for the renderer, watches TypeScript, and runs Electron with live reload.

37
Library-Workflow.md Normal file

@@ -0,0 +1,37 @@
# Library Workflow
Heres how the whole audio management loop works inside AudioSort — from scanning to tagging to cleaning things up.
## Initial Scan
1. Pick your library folder when you first launch the app (or later via **Settings → Library Path**).
2. Hit **Rescan Library** in the File menu — AudioSort will crawl all your `.wav` / `.wave` files, grabbing duration, bit depth, checksums, and waveform previews.
3. If youve deleted something from disk, it drops from the database automatically. Unchanged files keep their tags and metadata intact.
## Tagging and Categories
* AudioSort writes metadata straight into the WAVs INFO chunk and keeps a copy in its SQLite database.
* UCS categories come from the built-in catalog. Tags are free-form — use whatever suits your workflow.
* The **File List** panel supports batch edits. Any updates stick even if you move or rename the files later.
## Organising
* **Organise File** moves a file based on its main category. Folder names are built from UCS codes plus your own custom label.
* **Rename** tweaks the files title and display name without changing its folder.
* The duplicate finder uses checksums to spot identical audio so you can merge or delete the extras fast.
## Splitting Audio
1. Open a file and drop in segments — set start/end times in ms, with optional names and tags.
2. Each split exports as a new WAV that inherits all metadata and links back to the parent via INFO data.
3. New segments get scanned automatically and show up right away for tagging.
## Waveform Previews
* Every file shows a mini waveform thumbnail after scanning.
* Previews rebuild themselves whenever you edit metadata or change the audio.
## Search
* The search bar does fuzzy matches on file names, tags, categories, and paths.
* You can also use filters like `author:<name>` to dig into embedded metadata.