Added images for wiki

2025-11-11 11:38:23 +11:00
parent 0ffb5e5036
commit 4700857acb
9 changed files with 18 additions and 12 deletions

8
FAQ.md

@@ -1,20 +1,24 @@
# FAQ
## The app cant find my library path ## The app cant find my library path
Make sure the folders readable and youve got permission to create subfolders. Make sure the folders readable and youve got permission to create subfolders.
AudioSort stores its database under `%APPDATA%/AudioSort/` on Windows. 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 ## My waveform preview looks flat
Waveform previews rebuild whenever files change. Try **Rescan Library** or tweak any bit of metadata to force a refresh. 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. If the files 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 groups look wrong
Duplicate detection uses MD5 hashes of the raw audio data. 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. If two files sound the same but still dont 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 ## Organise File sent stuff to weird folders
The organiser bases folders on the first UCS category in the file. The organiser bases folders on the first UCS category in the file.

@@ -1,5 +1,3 @@
# 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. 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 ## Highlights
@@ -22,4 +20,6 @@ Welcome to the AudioSort wiki. This is where youll find setup info, workflow
* [Library Workflow](Library-Workflow.md) * [Library Workflow](Library-Workflow.md)
* [FAQ](FAQ.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. Have an idea or found something that could be better? Open an issue or pull request in the main AudioSort repo.

@@ -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. AudioSort runs as a desktop app built with Electron. Follow the steps below to get it up and running on your machine.
## System Requirements ## 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. 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. 3. Once its done, launch AudioSort from the Start Menu or the desktop shortcut.
![Installer completion](assets/installer-finish.png)
## 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.
@@ -36,4 +36,4 @@ yarn install # or npm install
npm run dev 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.

@@ -1,5 +1,3 @@
# Library Workflow
Heres how the whole audio management loop works inside AudioSort — from scanning to tagging to cleaning things up. Heres how the whole audio management loop works inside AudioSort — from scanning to tagging to cleaning things up.
## Initial Scan ## Initial Scan
@@ -8,28 +6,32 @@ Heres 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. 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. 3. If youve 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 ## Tagging and Categories
* AudioSort writes metadata straight into the WAVs INFO chunk and keeps a copy in its SQLite database. * 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. * 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. * 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 ## Organising
* **Organise File** moves a file based on its main category. Folder names are built from UCS codes plus your own custom label. * **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. * **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. * 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 ## Splitting Audio
1. Open a file and drop in segments — set start/end times in ms, with optional names and tags. 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. 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. 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 ## Search

BIN
assets/installer-finish.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
assets/library-scan.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 153 KiB

BIN
assets/split-editor.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 236 KiB

BIN
assets/tagging-panel.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB