Add README with panel screenshots
Include screenshots showing files, branches, commits, stash panels and help menu. Update gitignore to allow screenshots/ directory. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
+2
-2
@@ -4,6 +4,6 @@ target/
|
|||||||
*.jar
|
*.jar
|
||||||
|
|
||||||
# Generated test outputs
|
# Generated test outputs
|
||||||
*.gif
|
|
||||||
*.png
|
|
||||||
test/e2e/output/
|
test/e2e/output/
|
||||||
|
test/e2e/*.gif
|
||||||
|
test/e2e/*.png
|
||||||
|
|||||||
@@ -0,0 +1,76 @@
|
|||||||
|
# lazygitclj
|
||||||
|
|
||||||
|
A lazygit-inspired TUI for Git written in Clojure, targeting Babashka for fast startup.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Elm Architecture**: Clean Model-Update-View pattern for predictable state management
|
||||||
|
- **Fast startup**: Runs on Babashka for sub-second launch times
|
||||||
|
- **Familiar keybindings**: Vim-style navigation (j/k, h/l) matching lazygit
|
||||||
|
- **Full Git workflow**: Stage, commit, branch, merge, stash, and more
|
||||||
|
|
||||||
|
## Panels
|
||||||
|
|
||||||
|
### Files Panel (2)
|
||||||
|
View and manage staged/unstaged files with inline diffs.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Branches Panel (3)
|
||||||
|
Switch branches, create new branches, merge, and fast-forward.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Commits Panel (4)
|
||||||
|
Browse commit history, checkout commits, cherry-pick, and revert.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Stash Panel (5)
|
||||||
|
Manage stashes - apply, pop, drop, or create branches from stash.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Help Menu (?)
|
||||||
|
Press `?` to see all available keybindings.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Requires [Babashka](https://github.com/babashka/babashka).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/yourusername/lazygitclj.git
|
||||||
|
cd lazygitclj
|
||||||
|
bb start
|
||||||
|
```
|
||||||
|
|
||||||
|
## Keybindings
|
||||||
|
|
||||||
|
| Key | Action |
|
||||||
|
|-----|--------|
|
||||||
|
| `q` | Quit |
|
||||||
|
| `?` | Help |
|
||||||
|
| `r` | Refresh |
|
||||||
|
| `h/l` | Previous/Next panel |
|
||||||
|
| `j/k` | Move down/up |
|
||||||
|
| `2-5` | Jump to panel |
|
||||||
|
| `space` | Stage/unstage (Files), Checkout (Commits/Branches), Apply (Stash) |
|
||||||
|
| `c` | Commit |
|
||||||
|
| `p/P` | Pull/Push |
|
||||||
|
| `z/Z` | Undo/Redo |
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bb start # Run the TUI
|
||||||
|
bb test # Run unit tests
|
||||||
|
bb test:e2e # Run VHS tape tests
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 103 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 61 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 117 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
Reference in New Issue
Block a user