emilis
/
termion
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
ticki 2016-07-02 15:42:18 +02:00
parent 7284a25d8f
commit a7821206e9
2 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,8 +1,14 @@
# Termion # Termion
A pure Rust library for handling, manipulating and reading information about terminals. This provides a full-featured alternative to Termbox. Termion is a pure Rust, bindless library for low-level handling, manipulating
and reading information about terminals. This provides a full-featured
alternative to Termbox.
Supports Redox and POSIX. Untested on Windows. Termion aims to be simple and yet expressive. It is bindless, meaning that it
is not a front-end to some other library (e.g., ncurses or termbox), but a
standalone library directly talking to the TTY.
Supports Redox, Mac OS X, and Linux (or, in general, ANSI terminals).
[Documentation.](http://ticki.github.io/termion/termion/) | [Examples.](https://github.com/Ticki/termion/tree/master/examples) [Documentation.](http://ticki.github.io/termion/termion/) | [Examples.](https://github.com/Ticki/termion/tree/master/examples)

14
src/lib.rs
View File

@ -1,8 +1,14 @@
//! termion is a pure Rust library for reading, manipulating, and handling terminals. //! Termion is a pure Rust, bindless library for low-level handling, manipulating
//! and reading information about terminals. This provides a full-featured
//! alternative to Termbox.
//! //!
//! This crate is not stable, yet. However, if you do want stability, you should specify the //! Termion aims to be simple and yet expressive. It is bindless, meaning that it
//! revision (commit hash) in your `Cargo.toml`, this way builds are complete reproducible, and won't //! is not a front-end to some other library (e.g., ncurses or termbox), but a
//! break. //! standalone library directly talking to the TTY.
//!
//! Supports Redox, Mac OS X, and Linux (or, in general, ANSI terminals).
//!
//! For more information refer to the [README](https://github.com/ticki/termion).
#![warn(missing_docs)] #![warn(missing_docs)]
#![cfg_attr(feature = "nightly", feature(io))] #![cfg_attr(feature = "nightly", feature(io))]