Skip to content

Commit 5ddc1ff

Browse files
committed
Add more conceptual documentation.
1 parent ca2b2bc commit 5ddc1ff

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

ui/src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
//! Rust bindings to `libui`, a wrapper library for native(ish) GUI libraries - Win32API on Windows, Cocoa on Mac OS X, and GTK+ on Linux and elsewhere.
22
//! This library exposes the a Rusty procedural interface to the "Least Common Denominator" of GUI widgets. They are all available on all supported platforms.
33
//!
4+
//! To use this library, import it in your `Cargo.toml`:
5+
//!
6+
//! ```ignore
7+
//! ui = { git = "https://github.com/LeoTindall/libui-rs" }
8+
//! ```
9+
//!
10+
//! `libui` requires some global initialization and, thus, deinitialization. This is implemented as the [`UI`](struct.UI.html) RAII guard.
11+
//!
12+
//! Buttons, text entry boxes, and all other GUI elements are implemented as "controls".
13+
//! They can only be displayed as children of a [`Window`](window/struct.Window.html).
14+
//!
415
//! # Example
516
//!
617
//! ```

0 commit comments

Comments
 (0)