From 5713fd490a7d4ea28a9388a3dcac103535d5ecf0 Mon Sep 17 00:00:00 2001 From: Alexandre Bury Date: Tue, 19 May 2015 10:01:54 -0700 Subject: [PATCH] Update readme --- Readme.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index b53cb8a..211c1a5 100644 --- a/Readme.md +++ b/Readme.md @@ -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). -It is designed to be safe, and easy to use: +It is designed to be safe and easy to use: ```rust extern crate cursive; @@ -14,9 +14,14 @@ fn main() { let mut siv = Cursive::new(); // 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. 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.