summaryrefslogtreecommitdiffstats
path: root/vendor/term/README.md
blob: 8dc2f19d68e1d9ecba2b5610f38da37110df2bde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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.