0.1.0 release!

Author: NoraCodes

README.md

@@ -1,17 +1,76 @@
-# libUI
+# The Improved User Interface Crate
 [![libui-rs build status](https://api.travis-ci.org/LeoTindall/libui-rs.svg?branch=master)](https://travis-ci.org/LeoTindall/libui-rs/)
 
-A Rusty user interface library that binds to platform native APIs. 
-These are work-in-progress Rust bindings to the minimalistic native UI library [libui][libui].
+`iui` is a simple, small, easy to distribute GUI library, a Rusty user interface library that binds to platform native APIs.
+These are work-in-progress bindings to the minimalistic native UI library [libui][libui].
 
-## Building
-`libui` is included as a submodule. You will need CMake to build `libui` itself; 
-after that, Cargo should be able to take care of the build process.
+Add this to your crate with:
 
-Based on work by @pcwalton
+```
+iui = "0.1.0"
+```
 
-[libui]: https://github.com/andlabs/libui
+## Example
+
+```
+extern crate iui;
+use iui::prelude::*;
+use iui::controls::{VerticalBox, MultilineEntry, Button};
+use std::io::prelude::*;
+use std::error::Error;
+use std::fs::File;
+
+fn main() {
+    // Initialize the UI
+    let ui = UI::init().unwrap();
+
+    // Create the input controls
+    let entry = MultilineEntry::new(&ui);
+    let button = Button::new(&ui, "Save Buffer");
+
+    // Set up the application's layout
+    let window = Window::new(&ui, "Save Buffer to File", 640, 480, WindowType::NoMenubar);
+    let vbox = VerticalBox::new(&ui);
+    vbox.append(&ui, entry.clone(), LayoutStrategy::Stretchy);
+    vbox.append(&ui, button.clone(), LayoutStrategy::Compact);
+    window.set_child(&ui, vbox);
+    window.show(&ui);
+
+    // When the button is clicked, get the name of a file and then write the entry's contents to it.
+    // Note the in real code you should spin off a thread to do the actual writing, do it between UI events,
+    // or use Tokio. Even with minmal content, this method shows noticable lag.
+    button.on_clicked(&ui, {
+        let ui = ui.clone();
+        move |_| {
+            if let Some(path) = window.save_file(&ui) {
+                let mut file = match File::create(&path) {
+                    Err(why) => { window.modal_err(&ui, "I/O Error", &format!("Could not open file {}: {}", path.display(), why.description())); return; }
+                    Ok(f) => f
+                };
+                match file.write_all(entry.value(&ui).as_bytes()) {
+                    Err(why) => { window.modal_err(&ui, "I/O Error", &format!("Could not write to file {}: {}", path.display(), why.description())); return; }
+                    Ok(_) => ()
+                };
+            }    
+        }
+    });
 
-# Testing Note
+    ui.main();
+}
+```
 
+## Organization
+
+`iui` is the safe Rust wrapper, to be used by most users.
+`ui` is the old version of the safe wrapper. Don't use this.
+`ui-sys` is the raw unsafe bindings to the `libui` C code. Requires `cmake` so it can build `libui`.
+
+## Building
+`libui` is included as a submodule. You will need CMake to build `libui` itself.
+
+Based on work by @pcwalton. Licensed MIT.
+
+## Testing Note
 Travis does not connect video devices to their testing environments, so the tests cannot be run. Therefore, the "tests" only check compilation.
+
+[libui]: https://github.com/andlabs/libui

iui/Cargo.toml

@@ -3,9 +3,48 @@ name = "iui"
 version = "0.1.0"
 authors = ["Leo Tindall <[email protected]>"]
 
+# A short blurb about the package. This is not rendered in any format when
+# uploaded to crates.io (aka this is not markdown).
+description = "Simple, small, easy to distribute GUI bindings."
+
+# These URLs point to more information about the package. These are
+# intended to be webviews of the relevant data, not necessarily compatible
+# with VCS tools and the like.
+documentation = "https://docs.rs/iui/"
+repository = "https://github.com/LeoTindall/libui-rs"
+
+# This points to a file under the package root (relative to this `Cargo.toml`).
+# The contents of this file are stored and indexed in the registry.
+# crates.io will render this file and place the result on the crate's page.
+readme = "../README.md"
+
+# This is a list of up to five keywords that describe this crate. Keywords
+# are searchable on crates.io, and you may choose any words that would
+# help someone find this crate.
+keywords = ["windows", "gtk", "gui", "user interface", "macos"]
+
+# This is a list of up to five categories where this crate would fit.
+# Categories are a fixed list available at crates.io/category_slugs, and
+# they must match exactly.
+categories = ["gui", "os::macos-apis", "os::unix-apis", "os::windows-apis"]
+license = "MIT"
+
+[badges]
+# Travis CI: `repository` in format "<user>/<project>" is required.
+# `branch` is optional; default is `master`
+travis-ci = { repository = "LeoTindall/libui-rs", branch = "master" }
+
+# Is it maintained resolution time: `repository` is required.
+is-it-maintained-issue-resolution = { repository = "LeoTindall/libui-rs" }
+
+# Is it maintained percentage of open issues: `repository` is required.
+is-it-maintained-open-issues = { repository = "LeoTindall/libui-rs" }
+
+maintenance = { status = "actively-developed" }
+
 [dependencies]
 bitflags = "0.7"
-libc = "*"
+libc = "0.2"
 failure = "0.1.1"
 
 [dependencies.ui-sys]