vendor/term-0.6.1/README.md

   1 term
   2 ====
   3
   4 A Rust library for terminfo parsing and terminal colors.
   5
   6 [![Build Status](https://travis-ci.org/Stebalien/term.svg?branch=master)](https://travis-ci.org/Stebalien/term)
   7 [![Build status](https://ci.appveyor.com/api/projects/status/2duvop23k4n3owyt?svg=true)](https://ci.appveyor.com/project/Stebalien/term)
   8
   9 [Documentation](https://stebalien.github.io/doc/term/term/)
  10
  11 ## Usage
  12
  13 Add this to your `Cargo.toml`:
  14
  15 ```toml
  16 [dependencies]
  17
  18 term = "*"
  19 ```
  20
  21 and this to your crate root:
  22
  23 ```rust
  24 extern crate term;
  25 ```
  26
  27 ## Packaging and Distributing
  28
  29 For all terminals but windows consoles, this library depends on a non-hashed
  30 (for now) terminfo database being present. For example, on Debian derivitives,
  31 you should depend on ncurses-term; on Arch Linux, you depend on ncurses; and on
  32 MinGW, you should depend on mingw32-terminfo.
  33
  34 Unfortunately, if you're using a non-windows console on Windows (e.g. MinGW,
  35 Cygwin, Git Bash), you'll need to set the TERMINFO environment variable to
  36 point to the directory containing the terminfo database.