# Warble

- [Introduction](/docs): Warble is free, open source voice dictation for macOS that runs entirely on your Mac.
- [Installation](/docs/installation): Build Warble from source and install it in ~/Applications.
- [Your first dictation](/docs/first-run): What the setup window asks for, and why.

- **Using Warble**
- [Dictating](/docs/dictating): Hold to talk, toggle mode, and what happens between key press and typed text.
- [Recording pill](/docs/recording-pill): The glass capsule that shows Warble is listening.
- [History](/docs/history): Find, copy and replay anything you have dictated.
- [Dictionary](/docs/dictionary): Teach Warble your names, jargon and text shortcuts.
- [Settings](/docs/settings): Every option, and what it changes. Changes save instantly.
- [Languages](/docs/languages): The languages you can pick in Warble, and how to choose one.

- **Reference**
- [Command line](/docs/cli): The warble command for scripting and quick changes.
- [Configuration file](/docs/configuration): The keys in ~/.config/warble/config.json.
- [Privacy](/docs/privacy): What Warble records, where it goes, and what never leaves your Mac.
- [Troubleshooting](/docs/troubleshooting): Fixes for the problems people actually hit.

- **Project**
- [Architecture](/docs/architecture): How the pieces fit, for contributors and anyone forking Warble.
- [Contributing](/docs/contributing): Build, test, take screenshots and send a pull request.