arnekeller/cursive
1
0
Fork 0
mirror of https://github.com/FliegendeWurst/cursive.git synced 2024-11-23 17:35:00 +00:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Alexandre Bury 2015-05-19 10:01:54 -07:00
parent 04121414e1
commit 5713fd490a
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Readme.md
View File

@ -3,7 +3,7 @@ Cursive
Cursive is a ncurses-based TUI (Text User Interface) library for rust. It is based on jeaye's [ncurses-rs](https://github.com/jeaye/ncurses-rs). Cursive is a ncurses-based TUI (Text User Interface) library for rust. It is based on jeaye's [ncurses-rs](https://github.com/jeaye/ncurses-rs).
It is designed to be safe, and easy to use: It is designed to be safe and easy to use:
```rust ```rust
extern crate cursive; extern crate cursive;
@ -14,9 +14,14 @@ fn main() {
let mut siv = Cursive::new(); let mut siv = Cursive::new();
// Create a popup window with a "Ok" button that quits the application // Create a popup window with a "Ok" button that quits the application
siv.add_layer(Dialog::new("Hello world!").button("Ok", |s| s.quit())); siv.add_layer(Dialog::new("Hello world!").button("Ok", |s, _| s.quit()));
// Starts the event loop. // Starts the event loop.
siv.run(); siv.run();
} }
``` ```
A few notes :
* The main focus point is _not_ performance. This is a simple layout library, guys, not [compiz](https://www.google.com/search?q=compiz&tbm=isch) piped into [libcaca](https://www.google.com/search?q=libcaca&tbm=isch). Unless you are running it on your microwave's microcontroller, it's not going to be slow.
* The library is single-threaded. Thus, callback methods are blocking - careful what you're doing in there! Feel free to use threads on your side, though.