Skip to content

Commit 07f94d6

Browse files
committed
Update outdated READMEs of subcrates
1 parent 8d1e639 commit 07f94d6

File tree

3 files changed

+1
-58
lines changed

3 files changed

+1
-58
lines changed

core/README.md

-12
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,3 @@ This crate is meant to be a starting point for an Iced runtime.
1313
</p>
1414

1515
[documentation]: https://docs.rs/iced_core
16-
17-
## Installation
18-
Add `iced_core` as a dependency in your `Cargo.toml`:
19-
20-
```toml
21-
iced_core = "0.9"
22-
```
23-
24-
__Iced moves fast and the `master` branch can contain breaking changes!__ If
25-
you want to learn about a specific release, check out [the release list].
26-
27-
[the release list]: https://github.com/iced-rs/iced/releases

wgpu/README.md

+1-34
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,7 @@
66

77
`iced_wgpu` is a [`wgpu`] renderer for [`iced_runtime`]. For now, it is the default renderer of Iced on [native platforms].
88

9-
[`wgpu`] supports most modern graphics backends: Vulkan, Metal, and DX12 (OpenGL and WebGL are still WIP). Additionally, it will support the incoming [WebGPU API].
10-
11-
Currently, `iced_wgpu` supports the following primitives:
12-
- Text, which is rendered using [`wgpu_glyph`]. No shaping at all.
13-
- Quads or rectangles, with rounded borders and a solid background color.
14-
- Clip areas, useful to implement scrollables or hide overflowing content.
15-
- Images and SVG, loaded from memory or the file system.
16-
- Meshes of triangles, useful to draw geometry freely.
9+
[`wgpu`] supports most modern graphics backends: Vulkan, Metal, DX12, OpenGL, and WebGPU.
1710

1811
<p align="center">
1912
<img alt="The native target" src="../docs/graphs/native.png" width="80%">
@@ -25,29 +18,3 @@ Currently, `iced_wgpu` supports the following primitives:
2518
[native platforms]: https://github.com/gfx-rs/wgpu#supported-platforms
2619
[WebGPU API]: https://gpuweb.github.io/gpuweb/
2720
[`wgpu_glyph`]: https://github.com/hecrj/wgpu_glyph
28-
29-
## Installation
30-
Add `iced_wgpu` as a dependency in your `Cargo.toml`:
31-
32-
```toml
33-
iced_wgpu = "0.10"
34-
```
35-
36-
__Iced moves fast and the `master` branch can contain breaking changes!__ If
37-
you want to learn about a specific release, check out [the release list].
38-
39-
[the release list]: https://github.com/iced-rs/iced/releases
40-
41-
## Current limitations
42-
43-
The current implementation is quite naive; it uses:
44-
45-
- A different pipeline/shader for each primitive
46-
- A very simplistic layer model: every `Clip` primitive will generate new layers
47-
- _Many_ render passes instead of preparing everything upfront
48-
- A glyph cache that is trimmed incorrectly when there are multiple layers (a [`glyph_brush`] limitation)
49-
50-
Some of these issues are already being worked on! If you want to help, [get in touch!]
51-
52-
[get in touch!]: ../CONTRIBUTING.md
53-
[`glyph_brush`]: https://github.com/alexheretic/glyph-brush

winit/README.md

-12
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,3 @@ It exposes a renderer-agnostic `Application` trait that can be implemented and t
1515
[documentation]: https://docs.rs/iced_winit
1616
[`iced_native`]: ../native
1717
[`winit`]: https://github.com/rust-windowing/winit
18-
19-
## Installation
20-
Add `iced_winit` as a dependency in your `Cargo.toml`:
21-
22-
```toml
23-
iced_winit = "0.9"
24-
```
25-
26-
__Iced moves fast and the `master` branch can contain breaking changes!__ If
27-
you want to learn about a specific release, check out [the release list].
28-
29-
[the release list]: https://github.com/iced-rs/iced/releases

0 commit comments

Comments
 (0)