From bbf648ce7a6eca59791171b0d51f1c2f7f8c507a Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Sat, 13 Mar 2021 17:16:24 -0500 Subject: prep for initial release --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..aff1aae --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# textmode + +`textmode` is a library for terminal interaction built on top of a real +terminal parsing library. It allows you to do arbitrary drawing operations on +an in-memory screen, and then update the visible terminal output to reflect the +in-memory screen via an optimized diff algorithm when you are finished. Being +built on a real terminal parsing library means that while normal curses-like +operations are available: + +```rust +use textmode::Textmode; +let mut tm = textmode::Output::new().await?; +tm.clear(); +tm.move_to(5, 5); +tm.set_fgcolor(textmode::color::RED); +tm.write_str("foo"); +tm.refresh().await?; +``` + +you can also write data containing arbitrary terminal escape codes to the +output and they will also do the right thing: + +```rust +tm.write(b"\x1b[34m\x1b[3;9Hbar\x1b[m"); +tm.refresh().await?; +``` + +This module is split into two main parts: `Output` and `Input`. See the +documentation for those types for more details. Additionally, the `blocking` +module provides an equivalent interface with blocking calls instead of async. -- cgit v1.2.3-54-g00ecf