README.md 845 Bytes
Newer Older
Ticki's avatar
Ticki committed
1 2 3
libterm
=======

4 5
A pure Rust library for handling, manipulating and reading information about terminals. This provides a full-featured alternative to Termbox.

Ticki's avatar
Ticki committed
6 7
Supports Redox and POSIX. Untested on Windows.

Ticki's avatar
Ticki committed
8 9 10 11 12
A note on stability
-------------------

This crate is not stable, yet. However, if you do want stability, you should specify the revision (commit hash) in your `Cargo.toml`, this way builds are complete reproducible, and won't break.

13 14 15 16 17 18 19 20 21 22 23
Features
--------

- Raw mode.
- Cursor movement.
- Color output.
- Text formatting.
- Console size.
- Control sequences.
- Termios control.
- Password input.
Ticki's avatar
Ticki committed
24 25 26
- Redox support.
- 256-color mode.
- Panic-free error handling.
Ticki's avatar
Ticki committed
27 28
- Special keys events (modifiers, special keys, etc.).
- Asynchronous key events.
Ticki's avatar
Ticki committed
29 30

and much more.
31 32 33 34 35

TODO
----

- Mouse input
Ticki's avatar
Ticki committed
36 37 38 39 40 41 42 43 44 45

Usage
-----

See `examples/`.

License
-------

MIT.