Skip to content
Free public beta until December 4, 2026: every course is open, no card needed. After that, the first chapter of each course stays free and full access is a one-time $39 ($19 for up to 100 founding members chosen for helpful feedback). Your progress is kept. How the beta works

README

The first document a developer reads, saying how to build, test and run each part.

A README states what a project is, the pinned tools to install, one command each to build and test every part, how to run it locally, where other documents are, and who owns it; it is tested by a newcomer on a clean machine.

Examples

  • The greenhouse README says how to build and test each part in one command and to run Mosquitto on 127.0.0.1:1883 locally.

  • A new developer got stuck because the README said only "install arduino-cli"; the fix names the pinned version 1.5.1.

See also

runbook decision record monorepo
Read the full section →