How to use this project, shown in code that runs.
Small enough to read. Complete enough to run.
Reserved, and holding nothing but this log until the project has someone to show how to use it: a library's callers, a command-line tool's operators, an API's clients. When it does, each example goes here, one file or folder per task, small enough to read in one sitting and complete enough to run as it stands.
An example is code, so it runs with the project's own commands. Make sure the
commands the ci job in
.github/workflows/checks.yml runs also
build the examples, so one that stops working fails a pull request before it
fails a reader. Some toolchains already look here by name: Cargo, for one,
finds every example in examples/ without being told.
What is not an example lives elsewhere: a test that proves behaviour in
tests/, a step-by-step guide in
docs/library/, and a page that opens in a
browser in assets/html/.
This directory is yours from the first commit. Nothing upstream will ever write to it or delete from it.
| Entry | Purpose |
|---|---|
README.md |
This file. |
🗂️ Machined Indexes redraws this log after every push to the default branch, from what each example says about itself: open each file with a comment saying what it shows, and give each folder a README of its own.
An example that does not run teaches the wrong thing.
Built with ❤️ by the Engineering Team. Distributed under the terms in LICENSE.