1
1
mirror of https://github.com/wez/wezterm.git synced 2024-11-25 21:07:39 +03:00
wezterm/term/README.md
Wez Furlong d547d938d8 term: rename crate to wezterm-term in advance of publishing
Add some more docs and remove a couple of dead bits of code.
2020-06-13 09:55:16 -07:00

22 lines
823 B
Markdown

# wezterm-term
This crate provides the core of the virtual terminal emulator implementation
used by [wezterm](https://wezfurlong.org/wezterm/). The home for this
crate is in the wezterm repo and development is tracked at
<https://github.com/wez/wezterm/>.
It is full featured, providing terminal escape sequence parsing, keyboard
and mouse input encoding, a model for the screen cells including scrollback,
sixel and iTerm2 image support, OSC 8 Hyperlinks and a wide range of
terminal cell attributes.
This crate does not provide any kind of gui, nor does it directly
manage a PTY; you provide a `std::io::Write` implementation that
could connect to a PTY, and supply bytes to the model via the
`advance_bytes` method.
The entrypoint to the crate is the [Terminal](terminal/struct.Terminal.html)
struct.
License: MIT