residual/docs
Watch
2
0
Fork
You've already forked docs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
20 commits 1 branch 0 tags 254 KiB
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Merith-TK 5e15a56fee docs: fix stale binary names, package paths, and build commands 
Binary names:
- res-init → residual-init
- res-login → residual-login
- residual-console → res-console (in titles)
- residual-sh → res-sh
- residual (persistence CLI) → res-os

Package paths:
- core/proc/ → core/lib/proc/
- core/ipc/ → core/lib/ipc/
- core/lock/ → core/lib/lock/
- core/script/ → core/lib/script/
- core/config → core/lib/config

Build commands:
- Old per-repo commands → single core/ module commands

Also updates .opencode agent files and skill.
2026-07-21 13:20:05 -07:00
.opencode docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
console docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
design docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
editor docs: update docs for res-edit/res-code split and theme enforcement 2026-07-12 17:55:47 -07:00
extra docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
future-ideas delete cabinet, was confusing AI agents 2026-07-12 14:00:08 -07:00
os docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
.gitignore chore: add .gitignore 2026-06-08 18:02:11 -07:00
architecture.md docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
init-design.md docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
keymap.md docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
LICENSE chore: add MIT license 2026-06-15 06:21:30 -07:00
README.md docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
res-dispatcher.md docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00
res-init-client.md docs: fix stale binary names, package paths, and build commands 2026-07-21 13:20:05 -07:00

README.md

residual — documentation

This repository contains all design, architecture, and usage documentation for the residual project.

Contents

Path Description
keymap.md Authoritative keybinding reference (console + editor)
architecture.md Repo layout and shared core/ package overview
init-design.md Full design spec for the init subsystem (Phases 1–4)
res-dispatcher.md res dispatcher: dynamic help, cache, env setup
res-init-client.md residual-init daemon/client mode reference
console/ Console docs: user reference, design internals, Lua scripting API
editor/ Editor docs: res-edit nano reference, res-code IDE reference, keymap remap plan
extra/ Extra utilities repo reference (calculator, res-code, etc.)
os/ OS distribution design (separate project)
design/ Cross-cutting design: aesthetic, Lua plans, core tooling overview
future-ideas/ Deferred ideas not currently on the roadmap

Repo layout

core/ is the single tool module (git.merith.xyz/residual/core); the applications live inside it as cmd/ binaries and internal/libs/<app>/ packages. extra/, editor/, os/, and docs/ remain separate repos.

Repo Module Binary
core/ git.merith.xyz/residual/core shared libs + res, residual-init, res-console, res-sh, residual-login, res-edit (res-demo, res-theme are developer/calibration tools)
editor/ git.merith.xyz/residual/editor archived (res-edit moved to core; res-code in extra)
extra/ git.merith.xyz/residual/extra extra utilities (res-calc, res-code, …)
os/ git.merith.xyz/residual/os res-os
docs/ (this repo) documentation only