# TwinDesk user guide

How to set up TwinDesk and what to do when something doesn't work. The
[README](../../README.md) shows every feature with pictures. These pages are for getting it
running and keeping it running.

| Page | What's in it |
|---|---|
| [Getting started](getting-started.md) | Install, first launch on each OS, pairing, what to turn on |
| [Troubleshooting](troubleshooting.md) | Devices that don't find each other, input, screens, files, the phone |
| [Known limitations](known-limitations.md) | What doesn't work yet, or can't, and why |
| [FAQ](faq.md) | Short answers to the questions people ask most |
| [Privacy and security](privacy-and-security.md) | What leaves your devices, how sessions are protected |

In more depth:

| Page | What's in it |
|---|---|
| [Multi-device (Mesh)](../multi-device.md) | Many computers and phones at once |
| [ReZume](../rezume.md) | Carrying a page, a video or a document to the other device |
| [Android as a peer](../android-peer.md) | The phone as a full device |
| [NixOS](../nixos.md) | The flake, the module and Wayland input |
| [Languages](../i18n.md) | Translating TwinDesk into your language |
| [Protocol](../protocol.md) and [capabilities](../capabilities.md) | How devices talk and how they agree what they can do |

What changed in each version is in the [changelog](../../CHANGELOG.md).

Something missing or wrong here? [Open an issue](https://github.com/InukaAsith/TwinDesk/issues)
or send a pull request.