diff options
author | Jesse Luehrs <doy@tozt.net> | 2019-11-04 09:17:05 -0500 |
---|---|---|
committer | Jesse Luehrs <doy@tozt.net> | 2019-11-04 09:19:42 -0500 |
commit | 8cd3ca2c07b29e61f18c0c34db8b34b36a42e03b (patch) | |
tree | 7331c8dbaa7132751df0b03f2030058a20d239d4 /README.md | |
parent | d52d752af9a4bde993af7b0cb871e60b41eca2e0 (diff) | |
download | vt100-rust-8cd3ca2c07b29e61f18c0c34db8b34b36a42e03b.tar.gz vt100-rust-8cd3ca2c07b29e61f18c0c34db8b34b36a42e03b.zip |
docs
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 19 insertions, 2 deletions
@@ -1,2 +1,19 @@ -This crate parses terminal data into an in-memory representation of the -screen. Building requires glib-2.0, gcc, and flex. +# vt100 + +This crate parses a terminal byte stream and provides an in-memory +representation of the rendered contents. + +## Overview + +This is essentially the terminal parser component of a graphical terminal +emulator pulled out into a separate crate. This can be used to not only +build graphical terminal emulators, but also many other types of +applications that need to interact with a terminal data stream directly, +such as terminal multiplexers or terminal recording applications. + +## Synopsis + +```rust +let mut screen = vt100::Screen::new(24, 80); +screen.process(b"this text is \x1b[31mRED\x1b[m"); +``` |