diff options
Diffstat (limited to 'vendor/term/README.md')
-rw-r--r-- | vendor/term/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/vendor/term/README.md b/vendor/term/README.md new file mode 100644 index 000000000..8dc2f19d6 --- /dev/null +++ b/vendor/term/README.md @@ -0,0 +1,34 @@ +term +==== + +A Rust library for terminfo parsing and terminal colors. + +[![CircleCI](https://circleci.com/gh/Stebalien/term.svg?style=svg)](https://circleci.com/gh/Stebalien/term) +[![AppVeyor](https://ci.appveyor.com/api/projects/status/2duvop23k4n3owyt?svg=true)](https://ci.appveyor.com/project/Stebalien/term) + +[Documentation](https://docs.rs/term/) + +## MSRV + +1.36 - the minimum version testable on circleci. + +## Usage + +Add this to your `Cargo.toml`: + +```toml +[dependencies] + +term = "*" +``` + +## Packaging and Distributing + +For all terminals but windows consoles, this library depends on a non-hashed +(for now) terminfo database being present. For example, on Debian derivitives, +you should depend on ncurses-term; on Arch Linux, you depend on ncurses; and on +MinGW, you should depend on mingw32-terminfo. + +Unfortunately, if you're using a non-windows console on Windows (e.g. MinGW, +Cygwin, Git Bash), you'll need to set the TERMINFO environment variable to +point to the directory containing the terminfo database. |