Getting Started

Singularity is a Wayland desktop environment built on labwc, with its own shell, a shared application framework, and a small family of first-party apps. It is designed to be calm by default, quick under your hands, and yours to shape.

This documentation has three parts.

Using Singularity

If you want to run and live in the desktop, start here:

• Install covers the ways to get Singularity onto a machine.
• First boot walks through the greeter and your first login.
• Desktop tour introduces the panel, the dock, and the overview, with deeper pages for each piece.

Building on Singularity

If you want to build apps, plugins, widgets, or themes:

• Under the Hood explains how the pieces fit together.
• Build from source gets the full system compiled.
• Build an App and vetro cover the app workflow.

The bigger picture

Singularity OS is where the project is heading, and Contributing is how to help get it there.