aboutsummaryrefslogtreecommitdiff
path: root/vendor/vt100/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/vt100/README.md')
-rw-r--r--vendor/vt100/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/vendor/vt100/README.md b/vendor/vt100/README.md
new file mode 100644
index 00000000..a8e1b8f6
--- /dev/null
+++ b/vendor/vt100/README.md
@@ -0,0 +1,36 @@
+# 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. Although you can use this crate
+to build a graphical terminal emulator, it also contains functionality
+necessary for implementing terminal applications that want to run other
+terminal applications - programs like `screen` or `tmux` for example.
+
+## Synopsis
+
+```rust
+let mut parser = vt100::Parser::new(24, 80, 0);
+
+let screen = parser.screen().clone();
+parser.process(b"this text is \x1b[31mRED\x1b[m");
+assert_eq!(
+ parser.screen().cell(0, 13).unwrap().fgcolor(),
+ vt100::Color::Idx(1),
+);
+
+let screen = parser.screen().clone();
+parser.process(b"\x1b[3D\x1b[32mGREEN");
+assert_eq!(
+ parser.screen().contents_formatted(),
+ &b"\x1b[?25h\x1b[m\x1b[H\x1b[Jthis text is \x1b[32mGREEN"[..],
+);
+assert_eq!(
+ parser.screen().contents_diff(&screen),
+ &b"\x1b[1;14H\x1b[32mGREEN"[..],
+);
+```