Table of Contents
The README makes claims. This file backs them up.
For each headline feature: what makes it work, where the code is, and an honest caveat. Link out to the technology’s own docs rather than over-explaining. Reference arXiv papers only where the approach is novel. Keep it brief — prove the claim, don’t write a textbook.
Paste the specific claim here.
— README
Brief explanation of how — 2-4 sentences. Link to the technology (Elixir, Zig, etc.) rather than explaining it from scratch.
Caveat: What doesn’t this cover? Where are the limits?
-
Implementation:
path/to/code -
Learn more: https://relevant-docs.example.com