Fix README of iced_runtime
This commit is contained in:
parent
99e0a71504
commit
1c36446115
1 changed files with 4 additions and 16 deletions
|
|
@ -1,22 +1,10 @@
|
||||||
# `iced_native`
|
# `iced_runtime`
|
||||||
[][documentation]
|
[][documentation]
|
||||||
[](https://crates.io/crates/iced_native)
|
[](https://crates.io/crates/iced_native)
|
||||||
[](https://github.com/iced-rs/iced/blob/master/LICENSE)
|
[](https://github.com/iced-rs/iced/blob/master/LICENSE)
|
||||||
[](https://discord.gg/3xZJ65GAhd)
|
[](https://discord.gg/3xZJ65GAhd)
|
||||||
|
|
||||||
`iced_native` takes [`iced_core`] and builds a native runtime on top of it, featuring:
|
`iced_runtime` takes [`iced_core`] and builds a native runtime on top of it.
|
||||||
- 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>
|
|
||||||
|
|
||||||
[documentation]: https://docs.rs/iced_native
|
[documentation]: https://docs.rs/iced_native
|
||||||
[`iced_core`]: ../core
|
[`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
|
[`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
Add `iced_native` as a dependency in your `Cargo.toml`:
|
Add `iced_runtime` as a dependency in your `Cargo.toml`:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
iced_native = "0.9"
|
iced_runtime = "0.9"
|
||||||
```
|
```
|
||||||
|
|
||||||
__Iced moves fast and the `master` branch can contain breaking changes!__ If
|
__Iced moves fast and the `master` branch can contain breaking changes!__ If
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue