You can’t put that in a README . It belongs in the codex.ini . Technically? It doesn’t exist. There is no official codex.ini specification from Microsoft, Linux, or any RFC.
The compiler doesn't care about your soul. But codex.ini does. Did you actually create a codex.ini ? Tag me in your repo. Let’s start a movement of documented memory over clever code.
Every developer knows the README.md . It’s the front porch of your software—welcoming, tidy, and usually read once. codex.ini
; codex.ini ; The Book of Truth for Project Phoenix ; Last Ritual: 2024-05-21 [genesis] author = "Alex Chen" date = "2023-11-01" license = "MIT" mission = "To reduce report generation time from 45 seconds to under 2."
[sacrifices] ; We chose SQLite over Postgres for deployment simplicity. ; We know this breaks at 10k concurrent users. We accept this fate. timestamp_accuracy = "Lost 10ms precision for 40% speed gain" ui_framework = "Vanilla JS. No React. We choose pain." You can’t put that in a README
Imagine a file that sits next to your .gitignore and docker-compose.yml . It doesn't compile. It doesn't run. It witnesses . Because the format is loose (it’s a text file, after all), the structure is sacred. Here is what a proper codex.ini looks like:
[oracles] ; The prophecies spoken by the linter we chose to ignore. #101 = "Disabled rule @typescript-eslint/no-explicit-any because the vendor API is a lie." #204 = "Sleep(500) added here. Do not remove. The upstream webhook needs to breathe." It doesn’t exist
But what about the messy, glorious, chaotic soul of your project? The trade-offs you made, the "why" behind the weird hack on line 42, or the specific spell you cast to get the linter to shut up?