Oscyl documentation
Oscyl is an open-source librarian and sound editor for hardware synths. It reads the programs on your synth, and lets you organise and edit them on a computer or a phone. Then it writes back only the programs you changed.
New here? Read the four pages of Start here in order, from What Oscyl is, and what it is not.
How this documentation is organised
| Part | Read it when you want to | Start with |
|---|---|---|
| Start here | understand what Oscyl is and how it works | What Oscyl is |
| Tutorials | learn by doing, one lesson at a time | Try Oscyl without a synth |
| How-to guides | finish one real task | Add a driver for a new synth |
| Reference | look up a fact | The driver contract |
| Explanation | understand why Oscyl is made the way it is | Architecture |
Explanation also holds the decision records (ADRs), which record decisions already made, and the RFCs, which propose a change before anyone makes it.
The Rust API reference of the crates that a driver or another project uses is on the website, at oscyl.github.io/oscyl/api.
Outside this book
- README: the project’s front page, with the downloads.
- CONTRIBUTING: how to send a change.
- GOVERNANCE: roles, decisions, driver tiers and driver acceptance.
- CHANGELOG: what each release changed.