-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,3 @@ | ||
| <p align="center"><img src="https://github.com/geom3trik/tuix/blob/main/docs/tuix-logo.png" width="320" height="180" alt="logo"></p> | ||
|
|
||
| --- | ||
|
|
||
|  | ||
| [](https://github.com/geom3trik/tuix/actions/workflows/build.yml) | ||
| [](https://discord.gg/aNkTPsRm2w) | ||
|
|
||
| Tuix is a cross-platform GUI toolkit written in Rust. | ||
|
|
||
| The driving principle behind tuix is to be a self-contained, small-as-possible, but still fast, toolkit for creating graphical user interfaces in Rust. | ||
|
|
||
| <p align="center"><a href="https://github.com/geom3trik/tuix/blob/main/examples/calculator.rs"><img src="https://github.com/geom3trik/tuix/blob/main/docs/calculator.png" alt="calculator"></a></p> | ||
|
|
||
| ## Features | ||
|
|
||
| - Build Cross-Platform Applications | ||
| - Flexible Layout | ||
| - Fully Customisable Styling | ||
| - Animatable Style Properties | ||
| - A Reactive Data Model | ||
| - Numerous Built-In Widgets | ||
| - Custom Widgets | ||
|
|
||
| <p align="center"><a href="https://github.com/geom3trik/tuix/blob/main/examples/editor.rs"><img src="https://github.com/geom3trik/tuix/blob/main/docs/editor.png" alt="editor"></a></p> | ||
|
|
||
| ## Including tuix | ||
|
|
||
| Add tuix to your project by adding `tuix = {git = "https://github.com/geom3trik/tuix", branch = "main"}` to your projects Cargo.toml under dependencies. | ||
|
|
||
| ### Debug Performance | ||
| Note: In order to get acceptable performance when running your app in Debug mode, it is highly recommended to add this to the Cargo.toml of your root crate: | ||
|
|
||
| ```toml | ||
| [profile.dev.package.tuix_core] | ||
| opt-level = 2 | ||
| [profile.dev.package.tuix_widgets] | ||
| opt-level = 2 | ||
| [profile.dev.package.femtovg] | ||
| opt-level = 2 | ||
| ``` | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Running Examples | ||
|
|
||
| You can run any of the examples with: | ||
| ``` | ||
| cargo run --example example_name --release | ||
| ``` | ||
| To run any example with the `baseview` backend: | ||
| ``` | ||
| cargo run --example example_name --no-default-features --features "baseview" --release | ||
| ``` | ||
|
|
||
| ### Hello GUI | ||
| Since it's probably best to learn by example, here is the "hello world" of GUI applications in tuix: | ||
|
|
||
| ```Rust | ||
| use tuix::*; | ||
|
|
||
| fn main() { | ||
|
|
||
| let app = Application::new(WindowDescription::new().with_title("Hello GUI"), |state, window| { | ||
|
|
||
| Button::with_label("Button") | ||
| .build(state, window.entity(), |builder| { | ||
| builder | ||
| .set_width(Pixels(100.0)) | ||
| .set_height(Pixels(30.0)) | ||
| .set_background_color(Color::from("#ff5e1a")) | ||
| .set_child_space(Stretch(1.0)) | ||
| }); | ||
| }); | ||
|
|
||
| app.run(); | ||
| } | ||
| ``` | ||
|
|
||
| You can run this example with: ```cargo run --example hello_gui --release``` | ||
|
|
||
| # Tuix Book (In Development) | ||
| [The Book](https://geom3trik.github.io/tuix-book/) | ||
|
|
||
| This project is no longer being maintained and has been superseded by [vizia](https://github.com/geom3trik/VIZIA), a reactive declarative GUI framework made with Rust. | ||
|
|