Rewrite README.md sentence by sentence (closes #190)

Browse Source

README.md is rewritten from scratch against the prose rules on issue 190
and checked statement by statement against the code on next. It leads
with what the program is and how to use it, documents the HTTP API, the
IRC listener, the web client and neoirc-cli, puts every setting in a
reference section, and ends with development, testing and a TODO
section that points at the tracker. Every reply number is in backticks,
every error list is bulleted, and a claim that holds for only one of
the HTTP API and the IRC listener says which. Where the old text
disagreed with the code, the PR body lists the disagreement; the code
decides.

Model: fable-5-1

...

This commit is contained in:

clawbot

2026-10-27 15:57:55 +00:00

parent 83a1585ddc

commit 22c65f9100

1 changed files with 1711 additions and 3239 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

README.md

+1711 -3239

File diff suppressed because it is too large Load Diff