Mir documentation

Mir is a compositor library designed to operate across a variety of Linux-based devices, including traditional desktops, IoT and embedded systems.

Mir is a modern way to build Wayland compositors, providing a well-defined, efficient, flexible and secure platform for graphical environments that makes it an ideal choice for both device manufacturers and desktop users.

In this documentation

These pages cover the key aspects of developing a compositor using Mir

Start here - hands-on introductions to Mir for new developers

How-to guides - step-by-step guides covering key operations and common tasks, including handling keyboard input and integrating custom wayland protocols

Technical information - specifications, APIs, architecture: kernel requirements, introduction to the MirAL API and more

Discussion and clarification of key topics, such as accessibility methods, security and more

Project and community

Mir is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

Thinking about using Mir for your next project? Get in touch!