termion/README.md

48 lines
1.1 KiB
Markdown
Raw Normal View History

2016-03-15 20:36:33 +00:00
Termion
2016-03-06 13:55:01 +00:00
=======
A pure Rust library for handling, manipulating and reading information about terminals. This provides a full-featured alternative to Termbox.
2016-03-07 21:19:35 +00:00
Supports Redox and POSIX. Untested on Windows.
2016-03-08 18:44:31 +00:00
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.
Features
--------
- Raw mode.
- Cursor movement.
- Color output.
- Text formatting.
- Console size.
- Control sequences.
- Termios control.
- Password input.
2016-03-08 18:44:31 +00:00
- Redox support.
- 256-color mode.
- Panic-free error handling.
2016-03-15 19:32:25 +00:00
- Special keys events (modifiers, special keys, etc.).
- Asynchronous key events.
2016-03-08 18:44:31 +00:00
and much more.
2016-03-15 19:39:08 +00:00
Usage
-----
See `examples/`, and the documentation, which can be rendered using `cargo doc`.
2016-03-15 20:36:33 +00:00
For a more complete example, see [a minesweeper implementation](https://github.com/redox-os/games-for-redox/blob/master/src/minesweeper.rs), that I made for Redox using termion.
2016-03-15 19:39:08 +00:00
TODO
----
- Mouse input
2016-03-06 13:55:01 +00:00
License
-------
MIT.