Noir documentation

Pick the job in front of you.

Start here

• Installation — every dependency instruction, in one place.
• Your first app — create a project, run it, press a button, and change the running screen. About ten minutes.

Finish a task

• Handle input and focus — keys, shortcuts, editable text, and pointer coordinates.
• Parse command-line arguments — read flags before the widget tree mounts.
• Test an app — check application state and the public mount and dispose behavior.

Understand the model

• Layout in terminal cells — constraints, whole-cell geometry, and bounded regions.
• State, identity, and ownership — what Noir keeps between builds, and who releases it.
• Architecture — how one event becomes the next terminal frame, and which layer owns what.

Add hooks and Signals with noir_signals

• Overview and setup — choose the optional companion package and find its guides, examples, and contracts.
• Manage state and resources — own a controller or a timer in a SignalWidget, and release it.
• Show shared state — display a model somebody else owns.
• Build a task list — five lessons that add hooks and Signals one change at a time, with a screenshot for each result.

Look something up

• Widget catalog — find the widget for a UI job.
• Platform support — targets, terminal capabilities, and known limits.
• API — generated symbols, package surfaces, and shipped commands.

Contribute

• Contributing  — repository setup, the four framework test harnesses, and drive mode.