me/iced
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

corrected images in README to be similar height

Browse source
This commit is contained in:
Casper Rogild Storm 2022-06-02 10:11:19 +02:00
parent cb712f3b84
commit ab7698f1f6
No known key found for this signature in database
GPG key ID: 8F52569F9DDB2ECC
1 changed files with 32 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -18,12 +18,13 @@ Inspired by [Elm].
<img src="https://thumbs.gfycat.com/LittleSaneHalicore-small.gif" height="350px"> <img src="https://thumbs.gfycat.com/LittleSaneHalicore-small.gif" height="350px">
</a> </a>
<a href="https://gfycat.com/politeadorableiberianmole"> <a href="https://gfycat.com/politeadorableiberianmole">
<img src="https://thumbs.gfycat.com/PoliteAdorableIberianmole-small.gif"> <img src="https://thumbs.gfycat.com/PoliteAdorableIberianmole-small.gif" height="350px">
</a> </a>
</div> </div>
## Features ## Features
* Simple, easy-to-use, batteries-included API * Simple, easy-to-use, batteries-included API
* Type-safe, reactive programming model * Type-safe, reactive programming model
* [Cross-platform support] (Windows, macOS, Linux, and [the Web]) * [Cross-platform support] (Windows, macOS, Linux, and [the Web])
@ -63,6 +64,7 @@ __Iced is currently experimental software.__ [Take a look at the roadmap],
[feel free to contribute!]: #contributing--feedback [feel free to contribute!]: #contributing--feedback
## Installation ## Installation
Add `iced` as a dependency in your `Cargo.toml`: Add `iced` as a dependency in your `Cargo.toml`:
```toml ```toml
@ -78,6 +80,7 @@ you want to learn about a specific release, check out [the release list].
[the release list]: https://github.com/iced-rs/iced/releases [the release list]: https://github.com/iced-rs/iced/releases
## Overview ## Overview
Inspired by [The Elm Architecture], Iced expects you to split user interfaces Inspired by [The Elm Architecture], Iced expects you to split user interfaces
into four different concepts: into four different concepts:
@ -179,6 +182,7 @@ to:
Browse the [documentation] and the [examples] to learn more! Browse the [documentation] and the [examples] to learn more!
## Implementation details ## Implementation details
Iced was originally born as an attempt at bringing the simplicity of [Elm] and Iced was originally born as an attempt at bringing the simplicity of [Elm] and
[The Elm Architecture] into [Coffee], a 2D game engine I am working on. [The Elm Architecture] into [Coffee], a 2D game engine I am working on.
@ -204,7 +208,9 @@ end-user-oriented GUI library, while keeping [the ecosystem] modular:
[the ecosystem]: ECOSYSTEM.md [the ecosystem]: ECOSYSTEM.md
## Troubleshooting ## Troubleshooting
### `GraphicsAdapterNotFound` ### `GraphicsAdapterNotFound`
This occurs when the selected [built-in renderer] is not able to create a context. This occurs when the selected [built-in renderer] is not able to create a context.
Often this will occur while using [`iced_wgpu`] as the renderer without Often this will occur while using [`iced_wgpu`] as the renderer without
@ -212,22 +218,25 @@ supported hardware (needs Vulkan, Metal or DX12). In this case, you could try us
[`iced_glow`] renderer: [`iced_glow`] renderer:
First, check if it works with First, check if it works with
```console ```console
$ cargo run --features iced/glow --package game_of_life cargo run --features iced/glow --package game_of_life
``` ```
and then use it in your project with and then use it in your project with
```toml ```toml
iced = { version = "0.4", default-features = false, features = ["glow"] } iced = { version = "0.4", default-features = false, features = ["glow"] }
``` ```
**NOTE:** Chances are you have hardware that supports at least OpenGL 2.1 or OpenGL ES 2.0, __NOTE:__ Chances are you have hardware that supports at least OpenGL 2.1 or OpenGL ES 2.0,
but if you don't, right now there's no software fallback, so it means your hardware but if you don't, right now there's no software fallback, so it means your hardware
doesn't support Iced. doesn't support Iced.
[built-in renderer]: https://github.com/iced-rs/iced/blob/master/ECOSYSTEM.md#Renderers [built-in renderer]: https://github.com/iced-rs/iced/blob/master/ECOSYSTEM.md#Renderers
## Contributing / Feedback ## Contributing / Feedback
Contributions are greatly appreciated! If you want to contribute, please Contributions are greatly appreciated! If you want to contribute, please
read our [contributing guidelines] for more details. read our [contributing guidelines] for more details.
@ -237,6 +246,7 @@ awesome folks) over the `#games-and-graphics` and `#gui-and-ui` channels in
the [Rust Community Discord]. I go by `lone_scientist#9554` there. the [Rust Community Discord]. I go by `lone_scientist#9554` there.
## Sponsors ## Sponsors
The development of Iced is sponsored by the [Cryptowatch] team at [Kraken.com] The development of Iced is sponsored by the [Cryptowatch] team at [Kraken.com]
[documentation]: https://docs.rs/iced/ [documentation]: https://docs.rs/iced/