Skip to content

Commit 7d5ac92

Browse files
committed
update docs
1 parent 20d4636 commit 7d5ac92

File tree

2 files changed

+28
-5
lines changed

2 files changed

+28
-5
lines changed

CLAUDE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,15 @@ cargo clippy # Lint
5252
## Environment Variables
5353

5454
- `SIVIT_NAV_LATCH_MS` - Navigation latch (ms) before drawing images (default: 150)
55-
- `SIVIT_RENDER_CACHE_SIZE` - Client-side render cache size (encoded images in memory, default: 15)
56-
- `SIVIT_TMUX_KITTY_MAX_PIXELS` - Max pixels for tmux+kitty in `Normal` mode (default: 1500000)
55+
- `SIVIT_RENDER_CACHE_SIZE` - Client-side render cache size (encoded images in memory, default: 100)
56+
- `SIVIT_TMUX_KITTY_MAX_PIXELS` - Max pixels for tmux+kitty in `Normal` mode (default: 2000000)
5757
- `SIVIT_FORCE_ALT_SCREEN` - Force alternate screen mode
5858
- `SIVIT_NO_ALT_SCREEN` - Disable alternate screen mode
5959
- `SIVIT_DEBUG` - Enable debug info in status bar
6060
- `SIVIT_TRACE_WORKER` - Write worker timing logs to `/tmp/sivit_worker.log`
6161
- `SIVIT_KGP_NO_COMPRESS` - Disable zlib compression for KGP transmission
62+
- `SIVIT_COMPRESS_LEVEL` - Zlib compression level 0-9 (default: 6, higher = smaller but slower)
63+
- `SIVIT_PREFETCH_COUNT` - Number of images to prefetch ahead/behind (default: 5)
6264

6365
## Coding Conventions
6466

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ A terminal-based image viewer with sxiv-like keybindings. Works over SSH with Tm
1010

1111
- Kitty Graphics Protocol (KGP) image rendering
1212
- sxiv/vim-like keyboard navigation (counts supported)
13+
- Zlib compression for fast image transmission
14+
- Prefetch adjacent images for instant navigation
1315
- Render cache for snappy navigation
1416
- `Fit` toggle (upscale to viewport) + `Normal` (shrink-only)
1517

@@ -23,6 +25,22 @@ Tested: Ghostty + tmux.
2325

2426
## Installation
2527

28+
### From Release
29+
30+
Download the latest binary from [Releases](https://github.com/kan-bayashi/sivit/releases):
31+
32+
```bash
33+
# macOS (Apple Silicon)
34+
curl -L https://github.com/kan-bayashi/sivit/releases/latest/download/sivit-aarch64-apple-darwin.tar.gz | tar xz
35+
sudo mv sivit /usr/local/bin/
36+
37+
# Linux (x86_64)
38+
curl -L https://github.com/kan-bayashi/sivit/releases/latest/download/sivit-x86_64-unknown-linux-gnu.tar.gz | tar xz
39+
sudo mv sivit /usr/local/bin/
40+
```
41+
42+
### From Source
43+
2644
```bash
2745
cargo install --path .
2846
```
@@ -54,9 +72,12 @@ Vim-like counts are supported (e.g. `5j`, `10G`).
5472

5573
| Env | Default | Description |
5674
|-----|---------|-------------|
57-
| `SIVIT_NAV_LATCH_MS` | `150` | Navigation latch (ms) before drawing images; helps rapid key taps feel snappy |
58-
| `SIVIT_RENDER_CACHE_SIZE` | `15` | Render cache entries (can be memory-heavy) |
59-
| `SIVIT_TMUX_KITTY_MAX_PIXELS` | `1500000` | Max pixels in `Normal` mode (tmux+kitty compatibility); ignored in `Fit` mode |
75+
| `SIVIT_NAV_LATCH_MS` | `150` | Navigation latch (ms) before drawing images |
76+
| `SIVIT_RENDER_CACHE_SIZE` | `100` | Render cache entries |
77+
| `SIVIT_PREFETCH_COUNT` | `5` | Number of images to prefetch ahead/behind |
78+
| `SIVIT_COMPRESS_LEVEL` | `6` | Zlib compression level 0-9 |
79+
| `SIVIT_KGP_NO_COMPRESS` | unset | Disable zlib compression |
80+
| `SIVIT_TMUX_KITTY_MAX_PIXELS` | `2000000` | Max pixels in `Normal` mode (tmux+kitty) |
6081
| `SIVIT_FORCE_ALT_SCREEN` | unset | Force alternate screen |
6182
| `SIVIT_NO_ALT_SCREEN` | unset | Disable alternate screen |
6283

0 commit comments

Comments
 (0)