summaryrefslogtreecommitdiff
path: root/README.org
Commit message (Collapse)AuthorAgeFilesLines
* docs(sixel): hard-state img2sixel as the recommended encoder + warn loudly ↵cashmere2026-04-261-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | when none is on PATH Users hit a silent-failure mode where `kitty-gfx--sixel-detect' returned true (terminal supports Sixel) but no encoder was on `PATH', so every `sixel-place' logged `no encoder found' and produced no image. The echo-area `message' from `sixel-encode' was easy to miss inside tmux, which made the issue look like a refresh / tmux passthrough bug. - README.org: Requirements section now explicitly lists a Sixel encoder as required and recommends `img2sixel' (libsixel) over ImageMagick, with the concrete numbers from PR #10's bench (~2.2x smaller payload, ~10x faster) and a note that this matters most inside tmux because every refresh re-emits the full DCS payload. Known-Limitations reworded: missing encoder = silent failure surfaced via the debug log. - AGENTS.md: Dependencies block reorganised the same way; adds a pointer to `just sixel-encoder' as the first step when diagnosing Sixel rendering bugs. - kitty-graphics.el: when the active backend is Sixel and `kitty-gfx--sixel-resolve-encoder' returns nil at mode-enable time, fire a `display-warning' (`*Warnings*' buffer + visible message) pointing at img2sixel/ImageMagick, so the failure is no longer buried in /tmp/kitty-gfx.log.
* feat(tmux): unlock Sixel backend inside tmux >= 3.4cashmere2026-04-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sixel detection used to hard-disable the moment `$TMUX' was set. That guard predates tmux 3.4 (released 2024-02-13), which ships native Sixel rendering, so we were rejecting a working configuration. Drop the hard guard, gate on a parsed `tmux -V' >= 3.4, and let users opt out via a new custom var. - `kitty-gfx-tmux-allow-sixel' (default t). Set to nil if your tmux build lacks `--enable-sixel' or if you want to avoid the upstream scroll artifact (tmux's cell buffer is not pixel-aware, so images may persist after scrolling). - `kitty-gfx--tmux-version' parses `tmux -V' once per session and caches the result in `kitty-gfx--tmux-version-cache' (with an `unset' sentinel so we can distinguish "not probed" from "no tmux"). - `kitty-gfx--tmux-sixel-supported-p' centralises the (in-tmux + opt-in + version >= 3.4) check. - `kitty-gfx--sixel-detect' now uses the helper instead of `(not in-tmux)'. Debug log gained `tmux-ver=' and `tmux-ok='. - AGENTS.md / README.org / CHANGELOG.org: limitation reworded from "no tmux support" to a partial entry that explains exactly what works and what the remaining caveats are (Kitty APC passthrough is still unimplemented; scroll artifacts are upstream). - justfile: new `test-sixel-tmux' recipe wraps `test-sixel-image' in `tmux new-session' for one-command interactive verification, and the sibling `test-sixel-image' recipe was switched from a fragile shell conditional to an elisp `when' so passing an encoder argument no longer breaks the parse. Refs #2.
* docs: v0.4.0 changelog + demo GIFs (kitty + foot/sixel)v0.4.0cashmere2026-04-041-2/+6
| | | | | | Add CHANGELOG.org with full 0.4.0 release notes covering sixel support, text sizing protocol, agent-shell, and bug fixes. Replace demo GIFs with backend-specific showcases: kitty.gif (truecolor) and foot.gif (sixel).
* docs: update README for Sixel backend and multi-protocol supportcashmere2026-03-201-29/+41
| | | | | | | | | - Mention Kitty + Sixel in title and overview - List Sixel-compatible terminals (foot, Konsole, xterm, mlterm, mintty) - Document auto-detection order and kitty-gfx-preferred-protocol defcustom - Simplify installation guard to (not (display-graphic-p)) - Add backend-specific sections to How It Works - Update Known Limitations for both protocols
* docs: update README with LaTeX preview, doc-view, zoom, new defaultscashmere2026-02-261-6/+16
| | | | | | | | | | - Add org LaTeX preview and doc-view to integrations list - Add usage instructions for LaTeX (C-c C-x C-l) and doc-view (n/p navigation, +/-/0 zoom) - Update customization table: max-width 120, max-height 40 - Add LaTeX (texlive+dvipng) and doc-view (ghostscript) to requirements - Note doc-view centering flash as known limitation
* Add demo filescashmere2026-02-241-0/+6
|
* feat: Add README.org and kitty-graphics.elcashmere2026-02-241-21/+29
|
* Add cell size query, synchronized output, and dirvish integrationcashmere2026-02-241-7/+24
| | | | | | | | | | | | | - Query terminal cell size via CSI 16t (XTWINOPS) instead of hardcoded 8x16 fallback, giving accurate image aspect ratios - Wrap all placement output in synchronized output (DEC mode 2026) to eliminate flicker during scroll and redisplay - Add native dirvish preview dispatcher (kitty-image) that hooks into dirvish-preview-dispatchers for automatic image preview - Improve shr/eww advice to detect actual image type from spec - Extract kitty-gfx--refresh-overlay for cleaner refresh cycle - Reset position cache on buffer/window change so images re-place after d=a - Bump version to 0.2.0, update package metadata and README
* Initial commit: kitty-graphics.elcashmere2026-02-241-0/+97
| | | | | | Display images in terminal Emacs via Kitty graphics protocol with direct placements. Integrates with org-mode (including org-link-preview for org 10.0+), image-mode, and shr/eww.
* initcashmere2026-02-231-0/+0