Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeaye/ncurses-rs
A low-level ncurses wrapper for Rust
https://github.com/jeaye/ncurses-rs
Last synced: 1 day ago
JSON representation
A low-level ncurses wrapper for Rust
- Host: GitHub
- URL: https://github.com/jeaye/ncurses-rs
- Owner: jeaye
- License: other
- Created: 2013-09-30T22:56:02.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T18:19:31.000Z (5 months ago)
- Last Synced: 2024-11-27T18:06:48.760Z (16 days ago)
- Language: Rust
- Homepage:
- Size: 422 KB
- Stars: 685
- Watchers: 15
- Forks: 99
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-cn - jeaye/ncurses-rs - ci.org/jeaye/ncurses-rs.svg?branch=master">](https://travis-ci.org/jeaye/ncurses-rs) (Libraries / Command-line)
- awesome-rust - jeaye/ncurses-rs - ci.org/jeaye/ncurses-rs.svg?branch=master">](https://travis-ci.org/jeaye/ncurses-rs) (Libraries / Command-line)
- awesome-rust - jeaye/ncurses-rs - ci.org/jeaye/ncurses-rs.svg?branch=master">](https://travis-ci.org/jeaye/ncurses-rs) (代码 / GUI)
- awesome-rust - jeaye/ncurses-rs
- awesome-rust-cn - jeaye/ncurses-rs
- awesome-rust-zh - jeaye/ncurses-rs - [ncurses](https://www.gnu.org/software/ncurses/)绑定 [<img src="https://api.travis-ci.org/jeaye/ncurses-rs.svg?branch=master">](https://travis-ci.org/jeaye/ncurses-rs) (库 / 命令行)
- awesome-rust - jeaye/ncurses-rs - [ncurses](https://www.gnu.org/software/ncurses/) bindings (Libraries / Command-line)
- awesome-rust - jeaye/ncurses-rs - ci.org/jeaye/ncurses-rs.svg?branch=master">](https://travis-ci.org/jeaye/ncurses-rs) (库 Libraries / 命令行 Command-line)
- fucking-awesome-rust - jeaye/ncurses-rs - 🌎 [ncurses](www.gnu.org/software/ncurses/) bindings (Libraries / Command-line)
- fucking-awesome-rust - jeaye/ncurses-rs - 🌎 [ncurses](www.gnu.org/software/ncurses/) bindings (Libraries / Command-line)
README
ncurses-rs [![Build Status](https://travis-ci.org/jeaye/ncurses-rs.png)](https://travis-ci.org/jeaye/ncurses-rs)
==========This is a *very thin* wrapper around the ncurses TUI lib.
**NOTE:** The ncurses lib is terribly unsafe and ncurses-rs is only the lightest
wrapper it can be. If you want a safe and idiomatic TUI library for Rust, look
elsewhere. If you want a 1:1 port of C to Rust or you want to crank a TUI out
C-style in Rust, this will probably do the trick.## Building
The compiled library will go to the `target` directory.
```
cargo build
```Note that you must to have the ncurses library installed and linkable for ncurses-rs to work. On Linux, this should be trivial. On OS X, consider installing ncurses using Homebrew. (Note that you have to force Homebrew to link the library to `/usr/local/lib`: `brew link --force ncurses` and set that path to
`LIBRARY_PATH` environmental variable.)## Examples
Examples are built by `cargo build`. To run them, use `cargo run --example ex_`. Example numbers increase along with the complexity of the example.
Current examples:
**1.** [Hello World](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_1.rs)
**2.** [Basic Input & Attributes](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_2.rs)
**3.** [Simple Pager](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_3.rs)
**4.** [Window Movement](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_4.rs)
**5.** [Menu Library](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_5.rs) (requires rust nightly)
**6.** [Pager & Syntax Highlighting](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_6.rs)
**7.** [Basic Input & Attributes (Unicode)](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_7.rs)
**8.** [Special ACS Characters](https://github.com/jeaye/ncurses-rs/blob/master/examples/ex_8.rs)## Environment variables
Some environment variables are read by `build.rs`:
If set, `NCURSES_RS_RUSTC_LINK_LIB` will be used for `NCURSES_RS_RUSTC_LINK_LIB`.
If set, `NCURSES_RS_RUSTC_FLAGS` will be used for `cargo:rustc-flags`.
If set, `NCURSES_RS_CFLAGS` will be used for the compilation of the test program `chtype_size.c`.