Developer documentation
These guides cover building and maintaining LILYGO UI applications. For operating an installed application, see User documentation.
Recommended reading order
- Development quick start: install the tools, create a project, and run it on a host.
- Development guide: understand AppKit, application manifests, runtime integration, and release responsibilities.
- Keyboard integration: connect controls to focus navigation, text input, and modal views.
- T-Display-CM0 hardware (Chinese Wiki): check board specifications and interfaces. Follow Quick start to flash the system image.
- FAQ: clarify supported devices, sysroot boundaries, and where to report issues.
Find an application example
Use the application catalog to find source repositories. The Template guide describes the starter application's counter UI; the development quick start explains how to create your own project from it.
The application user guides document the behavior to check on a device, including hardware requirements, saved data, and feature limitations.
Supporting projects in the CM0 workspace
These projects provide development tools, runtime dependencies, or system images. They are separate from the applications opened in Launcher.
| Project directory | Responsibility | Start here |
|---|---|---|
lpm | Project creation, host builds, tests, packaging, and deployment | Development quick start |
lilygo-cm0-appkit | Shared UI and runtime services | Development guide, Keyboard integration |
CM0BspBuilder | Application sysroot and cross-compilation toolchain | Development quick start |
packages | Application and runtime package registry | Development guide |
lilygo-ui-mesa-vc4 | Private Mesa VC4 runtime libraries; no Launcher UI | Its repository README and docs/build.md |
linux, lilygo-linux-dtoverlays | Kernel, hardware drivers, and device-tree overlays | T-Display-CM0 hardware (Chinese Wiki) and the relevant repository documentation |
pi-gen, rpi-image-gen, usbboot | System image generation and device provisioning tools | System image flashing and each tool's README |