diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2023-03-05 06:36:36 +0100 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2023-03-05 06:36:36 +0100 |
| commit | 1c36446115dcb46c373fbc62b9e4f1941bd5a383 (patch) | |
| tree | 2ee99f346931167d72f27b76e7a9f2cb66579072 /runtime/README.md | |
| parent | 99e0a71504456976ba88040f5d1d3bbc347694ea (diff) | |
| download | iced-1c36446115dcb46c373fbc62b9e4f1941bd5a383.tar.gz iced-1c36446115dcb46c373fbc62b9e4f1941bd5a383.tar.bz2 iced-1c36446115dcb46c373fbc62b9e4f1941bd5a383.zip | |
Fix `README` of `iced_runtime`
Diffstat (limited to 'runtime/README.md')
| -rw-r--r-- | runtime/README.md | 20 |
1 files changed, 4 insertions, 16 deletions
diff --git a/runtime/README.md b/runtime/README.md index 996daa76..497fd145 100644 --- a/runtime/README.md +++ b/runtime/README.md @@ -1,22 +1,10 @@ -# `iced_native` +# `iced_runtime` [][documentation] [](https://crates.io/crates/iced_native) [](https://github.com/iced-rs/iced/blob/master/LICENSE) [](https://discord.gg/3xZJ65GAhd) -`iced_native` takes [`iced_core`] and builds a native runtime on top of it, featuring: -- A custom layout engine, greatly inspired by [`druid`] -- Event handling for all the built-in widgets -- A renderer-agnostic API - -To achieve this, it introduces a bunch of reusable interfaces: -- A `Widget` trait, which is used to implement new widgets: from layout requirements to event and drawing logic. -- A bunch of `Renderer` traits, meant to keep the crate renderer-agnostic. -- A `Windowed` trait, leveraging [`raw-window-handle`], which can be implemented by graphical renderers that target _windows_. Window-based shells (like [`iced_winit`]) can use this trait to stay renderer-agnostic. - -<p align="center"> - <img alt="The native target" src="../docs/graphs/native.png" width="80%"> -</p> +`iced_runtime` takes [`iced_core`] and builds a native runtime on top of it. [documentation]: https://docs.rs/iced_native [`iced_core`]: ../core @@ -25,10 +13,10 @@ To achieve this, it introduces a bunch of reusable interfaces: [`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle ## Installation -Add `iced_native` as a dependency in your `Cargo.toml`: +Add `iced_runtime` as a dependency in your `Cargo.toml`: ```toml -iced_native = "0.9" +iced_runtime = "0.9" ``` __Iced moves fast and the `master` branch can contain breaking changes!__ If |