docs: fix README to match current CLI and TUI state#25
Merged
Conversation
The README was out of date after the max-turns removal and TUI-first refactor. Removes references to --tui and --max-turns flags, documents --headless mode, expands TUI controls to cover action bar / trade builder / discard keybindings, updates the architecture tree with new files (headless.rs, lib.rs, screens.rs, menu.rs, tui_human.rs), and replaces emdashes with double dashes per project style. Fixes #22 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README was out of date after the max-turns removal (#24) and TUI-first refactor. This PR brings it in sync with the actual codebase:
--tuiand--max-turnsflags (both no longer exist)--headlessmode and explains TUI-default vs headless dispatchheadless.rs,lib.rs,screens.rs,menu.rs,tui_human.rs)Fixes #22
PR Type
Checklist
AI Usage
AI Model/Tool used: Claude Opus 4.6 via Claude Code
Any Additional AI Details you'd like to share: AI cross-referenced the actual CLI struct in
headless.rs, TUI input handling inui/mod.rs, and file structure to identify all README inaccuracies.NOTE:
When responding to reviewer questions, please respond yourself rather than copy/pasting reviewer comments into an AI and pasting back its answer. We want to discuss with you, not your AI :)