Example configs overview

This page explains what each shipped example config is for and when to use it.

---

Why there are several examples

The examples are meant to show that the same compositor/runtime can support different styles of policy.

They are not just random demos. Each one is trying to teach a specific idea.

---

Which example should you start with?

Start here if you want the main baseline

• TTY baseline
• file: examples/tty-baseline.lua

This is the main TTY baseline example — copy this and edit it.

Start here if you want a tiling-like profile

• Tiling pages
• file: examples/tiling.lua

---

Shared helper files

Some examples also use:

• examples/lib/common.lua
• examples/rules.lua

Read Example shared helpers and rules if you want to understand those files directly before reading the main example configs.

---

Suggested learning order

A good order is:

1. TTY baseline
2. Tiling pages

That goes from simplest and most general toward more specific and more advanced policy.