update readme

This commit is contained in:
Harivansh Rathi 2025-12-14 16:13:12 -05:00
parent b268e72d81
commit b6d225bc54

View file

@ -1,8 +1,6 @@
# Veetcode # Veetcode
Built for people who enjoy programming, vim, claude code, ghostty panes and TUIs Built for people vim users who enjoy claude code, ghostty panes and TUIs
## Features
- Browse problems by difficulty (easy/medium/hard) - Browse problems by difficulty (easy/medium/hard)
- Auto-run tests on file write - Auto-run tests on file write
@ -11,29 +9,45 @@ Built for people who enjoy programming, vim, claude code, ghostty panes and TUIs
## Installation ## Installation
```bash ```bash
# Clone the repo
git clone https://github.com/harivansh-afk/veetcode.git git clone https://github.com/harivansh-afk/veetcode.git
cd veetcode cd veetcode
# Install with uv
uv sync uv sync
``` ```
## Usage ## Run
```bash ```bash
# Launch the TUI ./veet
uv run veetcode
# Or if installed globally
veetcode
``` ```
### Workflow ## Workflow
1. Launch the TUI 1. `./veet` — opens problem list
2. Select a problem with Enter 2. Select a problem, press Enter
3. Open `problems/<difficulty>/<name>/solution.py` in your editor 3. Edit `solution.py` in your editor
4. Implement the solution 4. Save — tests run automatically
5. Write file - tests run automatically 5. Repeat
6. Generate more problems :)
## Keys
| Key | Action |
|----------|-----------------|
| `j/k` | Navigate |
| `Enter` | Select |
| `Esc` | Back |
| `r` | Rerun tests |
| `q` | Quit |
| `Ctrl+P` | Command palette |
## Generate Problems
Use Claude Code slash commands in `.claude/commands/`:
- `/generate` — create a new problem
- `/hint` — get a hint
- `/explain` — explain the solution
- `/add-tests` — add more test cases
## Themes
Gruvbox by default. Change via `Ctrl+P` → "Change theme".