From 7de72d6a2764f7c57bec23563406e1b5d1ad61b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Ram=C3=B3n=20Jim=C3=A9nez?= Date: Thu, 26 Nov 2020 07:39:00 +0100 Subject: [PATCH] Update `README`s of subcrates --- core/README.md | 4 +++- glutin/README.md | 22 ++++++++++++---------- native/README.md | 4 +++- web/README.md | 2 -- wgpu/README.md | 4 +++- winit/README.md | 4 +++- 6 files changed, 24 insertions(+), 16 deletions(-) diff --git a/core/README.md b/core/README.md index 641612c0..9ec0df6a 100644 --- a/core/README.md +++ b/core/README.md @@ -8,7 +8,9 @@ This crate is meant to be a starting point for an Iced runtime. -![iced_core](../docs/graphs/core.png) +

+ The foundations +

[documentation]: https://docs.rs/iced_core diff --git a/glutin/README.md b/glutin/README.md index 34dec1b3..addb9228 100644 --- a/glutin/README.md +++ b/glutin/README.md @@ -1,24 +1,26 @@ -# `iced_winit` -[![Documentation](https://docs.rs/iced_winit/badge.svg)][documentation] -[![Crates.io](https://img.shields.io/crates/v/iced_winit.svg)](https://crates.io/crates/iced_winit) -[![License](https://img.shields.io/crates/l/iced_winit.svg)](https://github.com/hecrj/iced/blob/master/LICENSE) +# `iced_glutin` +[![Documentation](https://docs.rs/iced_glutin/badge.svg)][documentation] +[![Crates.io](https://img.shields.io/crates/v/iced_glutin.svg)](https://crates.io/crates/iced_glutin) +[![License](https://img.shields.io/crates/l/iced_glutin.svg)](https://github.com/hecrj/iced/blob/master/LICENSE) [![project chat](https://img.shields.io/badge/chat-on_zulip-brightgreen.svg)](https://iced.zulipchat.com) -`iced_winit` offers some convenient abstractions on top of [`iced_native`] to quickstart development when using [`winit`]. +`iced_glutin` offers some convenient abstractions on top of [`iced_native`] to quickstart development when using [`glutin`]. It exposes a renderer-agnostic `Application` trait that can be implemented and then run with a simple call. The use of this trait is optional. A `conversion` module is provided for users that decide to implement a custom event loop. -![iced_winit](../docs/graphs/winit.png) +

+ The native target +

-[documentation]: https://docs.rs/iced_winit +[documentation]: https://docs.rs/iced_glutin [`iced_native`]: ../native -[`winit`]: https://github.com/rust-windowing/winit +[`glutin`]: https://github.com/rust-windowing/glutin ## Installation -Add `iced_winit` as a dependency in your `Cargo.toml`: +Add `iced_glutin` as a dependency in your `Cargo.toml`: ```toml -iced_winit = "0.1" +iced_glutin = "0.1" ``` __Iced moves fast and the `master` branch can contain breaking changes!__ If diff --git a/native/README.md b/native/README.md index 31c7db88..849deb58 100644 --- a/native/README.md +++ b/native/README.md @@ -14,7 +14,9 @@ To achieve this, it introduces a bunch of reusable interfaces: - 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. -![iced_native](../docs/graphs/native.png) +

+ The native target +

[documentation]: https://docs.rs/iced_native [`iced_core`]: ../core diff --git a/web/README.md b/web/README.md index 810bd1ec..d6dd7950 100644 --- a/web/README.md +++ b/web/README.md @@ -8,8 +8,6 @@ The crate is currently a __very experimental__, simple abstraction layer over [`dodrio`]. -![iced_core](../docs/graphs/web.png) - [documentation]: https://docs.rs/iced_web [`iced_core`]: ../core [`dodrio`]: https://github.com/fitzgen/dodrio diff --git a/wgpu/README.md b/wgpu/README.md index 67cb59dd..4483733c 100644 --- a/wgpu/README.md +++ b/wgpu/README.md @@ -15,7 +15,9 @@ Currently, `iced_wgpu` supports the following primitives: - Images and SVG, loaded from memory or the file system. - Meshes of triangles, useful to draw geometry freely. -![iced_wgpu](../docs/graphs/wgpu.png) +

+ The native target +

[documentation]: https://docs.rs/iced_wgpu [`iced_native`]: ../native diff --git a/winit/README.md b/winit/README.md index 34dec1b3..8916afce 100644 --- a/winit/README.md +++ b/winit/README.md @@ -8,7 +8,9 @@ It exposes a renderer-agnostic `Application` trait that can be implemented and then run with a simple call. The use of this trait is optional. A `conversion` module is provided for users that decide to implement a custom event loop. -![iced_winit](../docs/graphs/winit.png) +

+ The native target +

[documentation]: https://docs.rs/iced_winit [`iced_native`]: ../native