Skip to content

contour-terminal/terminal-good-image-protocol

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Terminal *Good* Image Protocol

IMPORTANT: THIS PROJECT IS IN ALPHA STAGE & ACTIVE DEVELOPMENT

This repository aims to finish and formalize the *Good* Image Protocol that was posted on terminal-wg issue #26.

Goal of this repository

I want to finally formalize what other people have been already put great work in (see references), and also come up with a reference implementation (for verifying the spec and as a technical preview).

It would be nice if this repository serves as a communication hub for improving this spec that ideally enough terminal emulators will adopt so we could call this the future defacto image protocol for terminals, so that developers have it easier in the future on how to get images into their terminal applications.

Roadmap

  • get the actual non-subjective content extracted out of the other sources into this one specification draft.
  • create CI job for auto-generating PDF/markdown of the latest draft to be downloadable
  • create CI job for providing prereleases of the draft specification.
  • Move Changelog into .tex file and let CI's release.yml extract it from there
  • Create Github pages that have an auto-generated PDF/markdown version of this specification.
  • Hopefully get enough terminal and TUI app devs attracted to collaborate in a positive, friendly, and productive manner.
  • CLI tool for cating images onto the screen (a shell script should be sufficient).
  • CLI tool for testing the feature availability (could be integrated in the above tool with a --test flag)

FAQ

  • Why LaTeX and not Markdown? Expressivity and the fact that you can convert to Markdown: https://pandoc.org/demos.html
  • Why GitHub and not GitLab on freedesktop? Better reachability.

About

*Good* Image Protocol - a formalization of a proposal for a new image protocol for virtual terminal emulators

Topics

Resources

Stars

Watchers

Forks