Skip to content

docs: simplify README usage section and regenerate demo.gif#35

Merged
jsleemaster merged 1 commit into
mainfrom
docs/simplify-readme
Feb 12, 2026
Merged

docs: simplify README usage section and regenerate demo.gif#35
jsleemaster merged 1 commit into
mainfrom
docs/simplify-readme

Conversation

@jsleemaster

Copy link
Copy Markdown
Owner

Summary

  • Remove verbose usage examples, keyboard shortcuts, and configuration sections from all 4 README files (en, ko, ja, zh-CN)
  • Regenerate demo.gif with latest cltree

Test plan

  • Verify README renders correctly on GitHub

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Documentation update label Feb 12, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8113ddfc99

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines 50 to 52
```bash
# Start in current directory
cltree

# Start in specific directory
cltree --path /path/to/project

# Adjust tree width (10-50%)
cltree --tree-width 25

# Show hidden files
cltree --show-hidden
```

## Keyboard Shortcuts

| Key | Action |
|-----|--------|
| `Ctrl+Q` | Quit |

All other keystrokes are passed directly to Claude Code.

## Configuration

### Command line options

```
Options:
-p, --path <PATH> Working directory [default: .]
-w, --tree-width <WIDTH> Tree panel width percentage (10-50) [default: 30]
-a, --show-hidden Show hidden files
-d, --depth <DEPTH> Max tree depth [default: 10]
-h, --help Print help
-V, --version Print version
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document the reserved Ctrl+Q key again

Removing the keyboard-shortcut section leaves no mention that Ctrl+Q is intercepted by cltree, even though src/app.rs still exits on that key in handle_key; this makes the docs misleading in the exact scenario where a user presses Ctrl+Q expecting it to be forwarded to Claude Code. Re-adding a short note about the reserved quit shortcut would prevent unexpected session termination.

Useful? React with 👍 / 👎.

@jsleemaster jsleemaster merged commit 66e627c into main Feb 12, 2026
6 checks passed
@jsleemaster jsleemaster deleted the docs/simplify-readme branch February 12, 2026 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant