summaryrefslogtreecommitdiffstats
path: root/vendor/vte/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/vte/README.md')
-rw-r--r--vendor/vte/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/vendor/vte/README.md b/vendor/vte/README.md
new file mode 100644
index 0000000..a9c016a
--- /dev/null
+++ b/vendor/vte/README.md
@@ -0,0 +1,19 @@
+vte
+===
+
+[![Build Status](https://travis-ci.org/alacritty/vte.svg?branch=master)](https://travis-ci.org/alacritty/vte)
+[![Crates.io Version](https://img.shields.io/crates/v/vte.svg)](https://crates.io/crates/vte/)
+
+Parser for implementing virtual terminal emulators in Rust.
+
+The parser is implemented according to [Paul Williams' ANSI parser state
+machine]. The state machine doesn't assign meaning to the parsed data and is
+thus not itself sufficient for writing a terminal emulator. Instead, it is
+expected that an implementation of the `Perform` trait which does something
+useful with the parsed data. The `Parser` handles the book keeping, and the
+`Perform` gets to simply handle actions.
+
+See the [docs] for more info.
+
+[Paul Williams' ANSI parser state machine]: https://vt100.net/emu/dec_ansi_parser
+[docs]: https://docs.rs/crate/vte/