Skip to content

Documentation

Six guides that get you from an empty project to a screen on a board. The API reference lives on docs.rs; the design notes and every crate’s own README live in the repository.

Guide

Platforms

In the repository

  • Design notes — How it is built and why: architecture, rasteriser, text, keyboards, theming, and the milestone history.
  • Raspberry Pi — Getting a Pi to hand over a display at all, and what to check when it will not.
  • Windows — The Win32 control and the ActiveX shim, including the toolchain traps.
  • The .dform file — Why KDL, the version 1 schema, loading one from Rust, and what a form file will not do.
  • The designer — From a drawing to a running screen, end to end.
  • denise-arrange — The design note for content-driven sizing in an optional crate. Nothing is built yet.
  • Releasing — How a version goes to crates.io, and what each guard is for.

Questions, or something that does not work? Open an issue.