diff options
| author | blasty <blasty@local> | 2026-08-07 15:23:42 +0200 |
|---|---|---|
| committer | blasty <blasty@local> | 2026-08-07 15:23:42 +0200 |
| commit | e890cacc9cbff8289b2ecbd8ddef577463ea7dd6 (patch) | |
| tree | 01bc2ace7f3436552c699c525423eac8b88f2721 | |
| parent | README: rewrite, and fix the install it documented (diff) | |
| download | ida-tui-e890cacc9cbff8289b2ecbd8ddef577463ea7dd6.tar.gz ida-tui-e890cacc9cbff8289b2ecbd8ddef577463ea7dd6.tar.xz ida-tui-e890cacc9cbff8289b2ecbd8ddef577463ea7dd6.zip | |
README: drop the Layout section, trim Docs to the two worth opening
Layout was internal orientation, not something a reader of the README needs;
the source is right there. Docs listed six files, four of which are working
notes from problems already solved (paging findings, Textual pitfalls, the
port's own coverage doc, the upstream findings) -- interesting once, noise in
a front page. What is left is the two a user actually opens, and both are
still linked inline from the feature that needs them.
| -rw-r--r-- | README.md | 25 |
1 files changed, 2 insertions, 23 deletions
@@ -140,21 +140,6 @@ graphics protocol, `logo.ans` everywhere else. Support is detected by *asking th terminal*, not by sniffing `$TERM` (under a multiplexer, every variable you'd test is empty while the protocol works fine). -## Layout - -``` -idatui/codemode_client.py lease a database, run operations through Code Mode -idatui/remote_tools.py IDAPython that runs inside the database process -idatui/domain.py paging + caching, synchronous and thread-safe -idatui/app.py the Textual app -idatui/graph.py CFG layout — pure, no IDA, no Textual -idatui/rpc.py unix-socket control channel -``` - -Layers stay separate: `domain.py` owns no processes, `graph.py` does no I/O -(which is why its tests run offline in milliseconds), and `app.py` does no -analysis. - ## Tests ```sh @@ -177,14 +162,8 @@ flake, and the four ways a test here wastes minutes. ## Docs -| | | -|---|---| -| [`docs/RPC.md`](docs/RPC.md) | the RPC protocol | -| [`docs/GRAPH_VIEW.md`](docs/GRAPH_VIEW.md) | graph layout engine | -| [`docs/CODEMODE_PORT.md`](docs/CODEMODE_PORT.md) | lifecycle, API gaps, what's still IDAPython | -| [`docs/CODEMODE_UPSTREAM.md`](docs/CODEMODE_UPSTREAM.md) | findings sent to the Code Mode maintainers | -| [`docs/PAGING_FINDINGS.md`](docs/PAGING_FINDINGS.md) | paging and scale findings | -| [`docs/TEXTUAL_NOTES.md`](docs/TEXTUAL_NOTES.md) | Textual pitfalls, the hard way | +- [`docs/RPC.md`](docs/RPC.md) — the RPC protocol, verb by verb +- [`docs/GRAPH_VIEW.md`](docs/GRAPH_VIEW.md) — how the graph is laid out ## Known sharp edges |