Go to file
shortenda 65615c3c39 Fix typo 2016-03-16 01:43:35 -07:00
examples Libterm is now termion 2016-03-15 21:36:33 +01:00
src Fix typo 2016-03-16 01:43:35 -07:00
.gitignore Add README 2016-03-06 14:55:01 +01:00
Cargo.toml Libterm is now termion 2016-03-15 21:36:33 +01:00
LICENSE Add license 2016-03-08 09:30:24 +01:00
README.md Add docs link 2016-03-16 08:36:50 +01:00
image.png Example image 2016-03-16 08:11:35 +01:00

README.md

Termion

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

Supports Redox and POSIX. Untested on Windows.

Documentation. | Examples.

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.
  • Redox support.
  • 256-color mode.
  • Panic-free error handling.
  • Special keys events (modifiers, special keys, etc.).
  • Asynchronous key events.

and much more.

Usage

See examples/, and the documentation, which can be rendered using cargo doc.

For a more complete example, see a minesweeper implementation, that I made for Redox using termion.

TODO

  • Mouse input

License

MIT.