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

Update README

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2019-09-04 12:18:55 +02:00
parent c583a2174d
commit 26d4224a95
1 changed files with 14 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -7,18 +7,14 @@
A renderer-agnostic GUI library for Rust focused on simplicity and type-safety. A renderer-agnostic GUI library for Rust focused on simplicity and type-safety.
Inspired by [Elm]. Inspired by [Elm].
__Iced is in a experimental stage.__ [Features are still missing], [![Tour - Iced][gui_gif]][gui_gfycat]
[some optimizations are yet to be implemented], and there are probably _many_ [![Tour - Coffee][coffee_gui_gif]][coffee_gui_gfycat]
bugs. [Feel free to contribute!]
[Features are still missing]: https://github.com/hecrj/iced/issues?q=is%3Aissue+is%3Aopen+label%3Afeature [gui_gif]: https://thumbs.gfycat.com/VeneratedSourAurochs-small.gif
[some optimizations are yet to be implemented]: https://github.com/hecrj/iced/issues?q=is%3Aissue+is%3Aopen+label%3Aoptimization [gui_gfycat]: https://gfycat.com/veneratedsouraurochs
[Feel free to contribute!]: #contributing--feedback
[![UI Tour - Coffee][gui_gif]][gui_gfycat] [coffee_gui_gif]: https://thumbs.gfycat.com/GloomyWeakHammerheadshark-small.gif
[coffee_gui_gfycat]: https://gfycat.com/gloomyweakhammerheadshark
[gui_gif]: https://thumbs.gfycat.com/GloomyWeakHammerheadshark-small.gif
[gui_gfycat]: https://gfycat.com/gloomyweakhammerheadshark
## Features ## Features
* Simple, easy-to-use, renderer-agnostic API * Simple, easy-to-use, renderer-agnostic API
@ -27,6 +23,12 @@ bugs. [Feel free to contribute!]
* Built-in widgets * Built-in widgets
* Custom widget support * Custom widget support
__Iced is in a experimental stage.__ [Check out the issues] and
[feel free to contribute!].
[check out the issues]: https://github.com/hecrj/iced/issues
[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`:
@ -141,12 +143,6 @@ to:
Browse the [documentation] and the [examples] to learn more! Browse the [documentation] and the [examples] to learn more!
## Gallery
[![UI Tour - Coffee][gui_gif]][gui_gfycat]
[gui_gif]: https://thumbs.gfycat.com/GloomyWeakHammerheadshark-small.gif
[gui_gfycat]: https://gfycat.com/gloomyweakhammerheadshark
## 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.
@ -159,9 +155,9 @@ After release, different folks asked if the GUI could be split into a standalone
crate, and well... Iced is here! crate, and well... Iced is here!
As an interesting note, Iced does not rely on reference counting and interior As an interesting note, Iced does not rely on reference counting and interior
mutability at all! There is not a single `Rc`, `RefCell`, or similar used mutability. There is not a single `Rc`, `RefCell`, or similar used
directly in the library. As a consequence, compiler guarantees stay intact and directly in the library. As a consequence, compiler guarantees stay intact and
many kinds of filthy bugs and runtime errors are banished. No spooky action at many kinds of pesky bugs and runtime errors are banished. No spooky action at
a distance! a distance!
[this pull request]: https://github.com/hecrj/coffee/pull/35 [this pull request]: https://github.com/hecrj/coffee/pull/35