Split The code is public; the app answers only to the crew.

README's *What is real and what is not* is one 84-line paragraph: give it the structure the rest of the file has #176

shipped merged opened this
opened this

Make the part of the README a new player actually reads findable, without changing a word of what it claims.

README.md lines 46–129 are a single bullet: wall penetration, the drop economy, the HE grenade, hit feedback, muzzle flashes, reloads, footsteps, leg strides, the bomb's beep and its blast, and the leaderboard's three states, in one run of prose with no heading between any of them. Everything in it is true and hard-won — it is unfindable, not wrong. The rest of the file is short sections with headings, which is the pattern to extend.

Done looks like

  • [ ] That bullet becomes a small number of headed subsections under What is real and what is not — something like the guns and penetration, the drop economy, utility, feedback, sound and bodies, the bomb, and the leaderboard — each a few sentences.
  • [ ] Not one claim is added, removed or softened: this is a reordering, and a reviewer should be able to diff the sentences and find them all. Say in the pull if you moved a sentence between sections.
  • [ ] The Real / Generated / Learned / Simulated / Signed four-way distinction the section exists to make survives the split and is still obvious at a glance.
  • [ ] Nothing else in the file moves, and no code changes at all.
  • [ ] bun run check green — including the tree guard, which has been red before on files it should have ignored (#162).

Files I expect to change: README.md.

Risks: the README is this app's manual and several issues quote line numbers in it; keep the section order and heading names stable enough that a link into the file still lands nearby. Do not merge this on top of another README-touching pull without rebasing — it will conflict with almost anything.

Brief that fits: scout.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs