More documentation

src/event.rs

@@ -1,3 +1,5 @@
+//! User-input events and their effects.
+
 use std::rc::Rc;
 
 /// Callback is a function that can be triggered by an event.

src/lib.rs

@@ -1,12 +1,31 @@
+//! # Cursive
+//!
+//! Cursive is a TUI library built on top of ncurses-rs.
+//! It allows to easily build layouts for text-based applications.
+//!
+//! ## Example
+//! ```
+//! extern crate cursive;
+//!
+//! use cursive::Cursive;
+//! use cursive::view::TextView;
+//!
+//! fn main() {
+//!     let mut siv = Cursive::new();
+//!
+//!     siv.add_layer(TextView::new("Hello World!\nPress q to quit."));
+//!
+//!     siv.add_global_callback('q' as i32, |s| s.quit());
+//!
+//!     siv.run();
+//! }
+//! ```
+
 extern crate ncurses;
 
-/// User-input events and their effects.
 pub mod event;
-/// Defines various views to use when creating the layout.
 pub mod view;
-/// Makes drawing on ncurses windows easier.
 pub mod printer;
-/// 2D points.
 pub mod vec2;
 mod box_view;
 mod stack_view;

src/printer.rs

@@ -1,3 +1,5 @@
+//! Makes drawing on ncurses windows easier.
+
 use ncurses;
 use vec2::{Vec2,ToVec2};
 

src/vec2.rs

@@ -1,3 +1,5 @@
+//! 2D points.
+
 use std::ops::{Add, Sub};
 use std::cmp::min;
 

src/view.rs

@@ -1,3 +1,5 @@
+//! Defines various views to use when creating the layout.
+
 use event::EventResult;
 
 pub use box_view::BoxView;