Documentation
Documentation
The documentation lives in the vinyl-check repository and is synced into this website. It is written in English; the interface of vinyl-check itself is available in English and German.
Get started
Install vinyl-check, set up the turntable chain, and work through a first record.
- Installation and configuration
- Install vinyl-check from source, run it as a headless Raspberry Pi station or as a desktop app, and configure it.
- Setup guide
- Turntable chains from a USB deck to high end, alignment basics, level calibration and a checklist for every session.
- User guide
- The workflow in the interface: records, recording a side, reports, grades, cleaning comparison, master comparison and alignment runs.
Reference
How every figure is measured, how the station is built, and the rules of its interface.
- How vinyl-check measures
- How vinyl-check captures, detects clicks, segments a side, grades it, compares recordings and measures a turntable with a test record.
- Architecture: stations and Vinyl-Mind
- How a station is built today, and how stations will learn together through Vinyl-Mind without sharing audio.
- Design system
- The rules behind the interface: principles, information architecture, tokens, icons, components and a measurable design QA.
Project
Releases, code signing, translations and how to contribute.
- Code signing
- Signing status of the desktop apps, the first start on macOS and Windows, and how to check a download.
- Translating vinyl-check
- How the interface, API messages and PDF reports are translated, and how to add a language.
- Contributing to vinyl-check
- Bug reports, measurements, translations and code: development setup, tests, building the apps and code style.
- Changelog
- Release history of vinyl-check.