READMEs · Developer platform
Windmill README
Windmill's repository README introduces choosing scripts, workflows and self-hosting. Its section sequence moves from product orientation into setup while retaining project information for other repository visitors.
Our interpretation
Useful when you are building…
Teams explaining choosing scripts, workflows and self-hosting to developers deciding whether the product fits and where to begin.
Observed in the source
Patterns and sections
Main Concepts
The README names “Main Concepts” as an early route after introducing the project, giving a repository visitor a concrete place to continue.
Show me some actual script code
“Show me some actual script code” appears as a separate section, so readers can distinguish this topic from the initial product explanation.
Local Development
A further “Local Development” section extends the page beyond installation and helps visitors locate another kind of project information.
Section labels refer to the reviewed public source. Visual design and mobile behavior of the external page were not evaluated.
Adaptation ideas
What to apply to your own product
- Lead with a one-sentence explanation of choosing scripts, workflows and self-hosting, then give the reader one representative way to try it.
- Keep “Main Concepts” easy to find and ensure it reaches a version-matched setup path.
- Use a separate “Show me some actual script code” route only if it answers a distinct question for evaluators, users or contributors.
Tradeoff to consider
The page offers orientation, not proof that linked setup works end to end. A smaller product can keep fewer routes, but should still label prerequisites and the result a new user should expect.
Starting route
Start at the README's “Main Concepts” section and follow its linked setup route; commands and external configuration were not executed.
Source and version
- windmill/README.md at fee401f01eebe411675a19eeff07b6f5435660b1 · windmill-labs/windmill · GitHub ↗https://github.com/windmill-labs/windmill/blob/fee401f01eebe411675a19eeff07b6f5435660b1/README.md
Reviewed README at commit fee401f01eebe411675a19eeff07b6f5435660b1. The linked file is pinned to that revision; the live repository may change.
Retrieved with Firecrawl. Content reviewed; product not installed or tested. Annotations are original editorial analysis.