Repository navigation
Commit 13afa51
authored
docs: rebuild the README, with a hero, and proper attribution (#20)
* docs: rewrite the README around what Redcode is
The README described install, dev, and release mechanics but never said
what the project is or why the fork exists — a reader could not tell
Redcode from OpenCode with a rename.
Rewrite it around the actual product: the surfaces you can run, the
Workers fleet console, the runtime decisions that distinguish this fork
(Effect kernel with Location scoping, durable SessionV2 admission,
reversible Cordis plugin profiles, System Context as data), and the
dependency direction that reviews enforce.
Every claim is checked against the code: command descriptions come from
their `describe` strings, the native target list from the build script,
the dependency rules from AGENTS.md, and the release steps from
red-publish.yml.
* docs: name the opencode/Redcode split and the v2 status
A reader hits two surprises the first draft did not prepare them for:
the source says OpenCode almost everywhere while the product says
Redcode, and large parts of the v2 runtime are deliberately unfinished.
Add a short naming note, a Status section listing what is shipped and
what is explicitly deferred (crash recovery, clustering, workspace
placement, client API stabilization, dynamic plugins), the TUI's SDK-only
boundary, the packages that are not the product, and the CI contract that
keeps the single-artifact posture honest.
* docs: credit OpenCode and DeepSeek Harness properly
The README framed OpenCode as merely "upstream" and never mentioned
DeepSeek Harness at all, despite the runtime's composition model coming
straight from it and @deepseek-ai/cordis being a real dependency of Core.
Replace the terse Upstream section with Lineage, naming what each project
actually gave us: OpenCode's agent loop, providers, tools, LSP plumbing,
and TUI foundation; the Harness's reversible-ownership model, ordered
activation, package-owned invariants, and real-entry testing discipline,
plus its post-mortems and Cordis. Reframe the opening so the fork reads as
building on good work rather than replacing it, and explain that keeping
OpenCode's internal names is a deliberate choice to stay legible against
theirs.
* docs: rebuild the README in the red-skills mold
Follow the structure that worked for red-skills: a hero, badges, a
positioning line, attribution up front pointing at NOTICE, a Contents
block, and one distinction that organizes everything after it.
For Redcode that distinction is what ships versus what does not — the
repo inherits a monorepo far larger than the product, and telling the
two apart is the fastest way to read it. The core sections lead with
the Session model, since durable admission before execution is the
property the rest of the runtime is built around.
Adds docs/hero.svg and a NOTICE carrying the OpenCode fork attribution,
the DeepSeek Harness composition model, and Cordis — whose copyright is
Shigma's, not DeepSeek's, which the license text confirms.
* docs(opencode): give the npm package a real page
The registry page for @reddb-io/redcode was two lines written inline by
publish.ts — install command, nothing else. Anyone finding the package on
npm learned nothing about what it is.
Write a proper page there instead: what Redcode is, the platforms the
binary covers, a table of the commands worth knowing, a link to the
repository, and credit to OpenCode and DeepSeek Harness. The tarball now
ships NOTICE next to LICENSE so the attribution travels with the package.
It stays generated rather than copied from the repository README, whose
hero image and relative links only resolve on GitHub.1 parent 7b8733f commit 13afa51
5 files changed
Lines changed: 516 additions & 16 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
0 commit comments