licence and readme

This commit is contained in:
Harivansh Rathi 2025-12-14 15:29:06 -05:00
parent 2e800fc2a8
commit 10d6c16285
2 changed files with 48 additions and 0 deletions

5
LICENSE Normal file
View file

@ -0,0 +1,5 @@
MIT License
Copyright (c) 2025
Use it, its fun :)

View file

@ -0,0 +1,43 @@
# Veetcode
Built for people who enjoy programming, vim, claude code, ghostty panes and TUIs
## Features
- Browse problems by difficulty (easy/medium/hard)
- Auto-run tests when you save your solution
- Visual solved indicators
- Clean, minimal TUI
## Installation
```bash
# Clone the repo
git clone https://github.com/harivansh-afk/veetcode.git
cd veetcode
# Install with uv
uv sync
```
## Usage
```bash
# Launch the TUI
uv run veetcode
# Or if installed globally
veetcode
```
### Workflow
1. Launch the TUI
2. Select a problem with Enter
3. Open `problems/<difficulty>/<name>/solution.py` in your editor
4. Implement the solution
5. Write file - tests run automatically
## Generating Problems
Problems are generated via Claude Code slash commands