Welcome to the Smithay Handbook.

This is a work in progress, and intended to serve as a general manual for building Wayland-related software in Rust, using the tools from the Smithay project.

The first section is a general introduction on the Wayland protocol, its goals and architecture.

The second section is dedicated to the building of client apps that can run natively in any wayland environment, using wayland-client and SCTK.

The third section focuses on building compositors (or wayland servers) that act as both window managers and display servers, using wayland-server and Smithay.

Have a good read!