diff --git a/FAQ.md b/FAQ.md index 9d81a4c..39eb176 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,20 +1,24 @@ -# FAQ - ## The app can’t find my library path Make sure the folder’s readable and you’ve got permission to create subfolders. AudioSort stores its database under `%APPDATA%/AudioSort/` on Windows. +> 📸 **Suggested screenshot:** settings window showing the library path selector. Save to `assets/faq-library-path.png` and reference with `![Library path settings](assets/faq-library-path.png)`. + ## 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 file’s mostly silence, the flat preview might actually be accurate. +> 📸 **Suggested screenshot:** waveform list before and after a rescan. Use `assets/faq-waveform-refresh.png` with `![Waveform refresh](assets/faq-waveform-refresh.png)`. + ## Duplicate groups look wrong Duplicate detection uses MD5 hashes of the raw audio data. If two files sound the same but still don’t match, double-check their sample rate and bit depth — or normalise them externally before importing. +> 📸 **Suggested screenshot:** duplicate results panel highlighting checksum matches. Store as `assets/faq-duplicates.png` and embed via `![Duplicate groups](assets/faq-duplicates.png)`. + ## Organise File sent stuff to weird folders The organiser bases folders on the first UCS category in the file. diff --git a/Home.md b/Home.md index 1562f6e..bb16f01 100644 --- a/Home.md +++ b/Home.md @@ -1,5 +1,3 @@ -# AudioSort Docs - Welcome to the AudioSort wiki. This is where you’ll find setup info, workflow notes, and fixes for when things go sideways. It’s all built around the Electron app — your main tool for managing WAV libraries. ## Highlights @@ -22,4 +20,6 @@ Welcome to the AudioSort wiki. This is where you’ll find setup info, workflow * [Library Workflow](Library-Workflow.md) * [FAQ](FAQ.md) +![Main window overview](assets/main-window-overview.png) + Have an idea or found something that could be better? Open an issue or pull request in the main AudioSort repo. diff --git a/Installation.md b/Installation.md index 71ee643..bfb0713 100644 --- a/Installation.md +++ b/Installation.md @@ -1,5 +1,3 @@ -# 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 @@ -15,6 +13,8 @@ AudioSort runs as a desktop app built with Electron. Follow the steps below to g 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. +![Installer completion](assets/installer-finish.png) + ## Updating * You can install new versions right over the top of the old one — your settings and library data will stay safe. @@ -36,4 +36,4 @@ yarn install # or npm install npm run dev ``` -The dev script spins up Vite for the renderer, watches TypeScript, and runs Electron with live reload. +The dev script spins up Vite for the renderer, watches TypeScript, and runs Electron with live reload. \ No newline at end of file diff --git a/Library-Workflow.md b/Library-Workflow.md index 6191049..ec5be04 100644 --- a/Library-Workflow.md +++ b/Library-Workflow.md @@ -1,5 +1,3 @@ -# Library Workflow - Here’s how the whole audio management loop works inside AudioSort — from scanning to tagging to cleaning things up. ## Initial Scan @@ -8,28 +6,32 @@ Here’s how the whole audio management loop works inside AudioSort — from sca 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 you’ve deleted something from disk, it drops from the database automatically. Unchanged files keep their tags and metadata intact. +![Rescan workflow](assets/library-scan.png) + ## Tagging and Categories * AudioSort writes metadata straight into the WAV’s 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. +![Tagging panel](assets/tagging-panel.png) + ## 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 file’s 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. +> 📸 **Suggested screenshot:** demonstrate the organise dialog or duplicate results list. Add it as `assets/organize-dialog.png` with `![Organise dialog](assets/organize-dialog.png)`. + ## 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 +![Split editor](assets/split-editor.png) -* Every file shows a mini waveform thumbnail after scanning. -* Previews rebuild themselves whenever you edit metadata or change the audio. ## Search diff --git a/assets/installer-finish.png b/assets/installer-finish.png new file mode 100644 index 0000000..8ebb492 Binary files /dev/null and b/assets/installer-finish.png differ diff --git a/assets/library-scan.png b/assets/library-scan.png new file mode 100644 index 0000000..bed60cf Binary files /dev/null and b/assets/library-scan.png differ diff --git a/assets/main-window-overview.png b/assets/main-window-overview.png new file mode 100644 index 0000000..be81a6f Binary files /dev/null and b/assets/main-window-overview.png differ diff --git a/assets/split-editor.png b/assets/split-editor.png new file mode 100644 index 0000000..0cc8e8e Binary files /dev/null and b/assets/split-editor.png differ diff --git a/assets/tagging-panel.png b/assets/tagging-panel.png new file mode 100644 index 0000000..0c516b9 Binary files /dev/null and b/assets/tagging-panel.png differ