Skip to content

Commit

Permalink
Update documentation to mention changes for UTF-8.
Browse files Browse the repository at this point in the history
  • Loading branch information
sunfishcode committed Jun 15, 2020
1 parent b99b23f commit 1ff5500
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ 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.
machine], modified to work in terms of UTF-8 encodings.

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.

Expand Down
12 changes: 7 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
//! Parser for implementing virtual terminal emulators
//!
//! [`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 [`Perform`] is provided which does
//! something useful with the parsed data. The [`Parser`] handles the book
//! keeping, and the [`Perform`] gets to simply handle actions.
//! state machine], modified to work in terms of UTF-8 encodings.
//!
//! 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 [`Perform`] is provided which does something useful with the
//! parsed data. The [`Parser`] handles the book keeping, and the [`Perform`] gets to
//! simply handle actions.
//!
//! # Examples
//!
Expand Down

0 comments on commit 1ff5500

Please sign in to comment.