README.md

Conrod

An easy-to-use, 2D GUI library written entirely in Rust.

The API Documentation.

The Guide:

1. What is Conrod?
   • A Brief Summary
   • Screenshots and Videos
   • Feature Overview
   • Available Widgets
     • Primitive Widgets
     • Common Use Widgets
   • Immediate Mode
     • What is it?
     • Why use it?
     • Is Conrod Immediate or Retained?
   • The Builder Pattern
2. Getting Started
   • Installing Rust and Cargo
   • Running the Conrod Examples
3. Let's Create a GUI
   • Setup a Basic Window (using piston_window)
   • Conrod Setup
   • Instantiating Widgets
   • Widget Positioning and Layout
4. Using and Customising Themes
   • What is a Theme?
   • Custom Themes
   • Serializing Themes
5. Designing Custom Widgets (using the Widget trait)
   • The Widget trait
   • The widget_style! macro
   • The builder_methods! macro
   • Making a Button widget
6. Custom Graphics and Window Backends
   • Demonstration of Backend Implementation (using glium and glutin)
7. Internals
   • The Ui's Widget Graph
   • Ui::set_widgets - How does it work?
8. FAQ

The Guide is a work-in-progress. If a section is not linked, it is likely not yet implemented.

Current State

We're just starting to reach a stable-ish API pattern! There will still be some large changes, however these are more likely to be new features than API overhauls.

To get a clearer idea of where we're at see the issues and in particular, the 1.0.0 milestone.

Contributing

Want to help out? See Piston's how to contribute guide.

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Example Assets

• Google Noto (Apache2)