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

Add more implementation details to README

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2019-09-01 20:29:59 +02:00
parent c0083437eb
commit f09d71db27
2 changed files with 15 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -14,6 +14,8 @@ categories = ["gui"]
[dependencies] [dependencies]
stretch = "0.2" stretch = "0.2"
twox-hash = "1.5" twox-hash = "1.5"
# Enable to obtain conversion traits
winit = { version = "0.20.0-alpha3", optional = true } winit = { version = "0.20.0-alpha3", optional = true }
[dev-dependencies] [dev-dependencies]

18
README.md
View file

@ -141,7 +141,6 @@ to:
Browse the [documentation] and the [examples] to learn more! Browse the [documentation] and the [examples] to learn more!
## Gallery ## Gallery
[![UI Tour - Coffee][gui_gif]][gui_gfycat] [![UI Tour - Coffee][gui_gif]][gui_gfycat]
@ -152,8 +151,19 @@ Browse the [documentation] and the [examples] to learn more!
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.
Currently, Iced builds upon The core of the library was implemented during May in [this pull request], using
* [`stretch`] for flexbox-based layouting. [`stretch`] for flexbox-based layouting. It was later released as the main
feature of [Coffee 0.3.0].
After release, different folks asked if the GUI could be split into a standalone
crate, and well... Iced is here!
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
directly in the library.
[this pull request]: https://github.com/hecrj/coffee/pull/35
[Coffee 0.3.0]: https://github.com/hecrj/coffee/releases/tag/0.3.0
## Contributing / Feedback ## Contributing / Feedback
If you want to contribute, you are more than welcome to be a part of the If you want to contribute, you are more than welcome to be a part of the
@ -169,8 +179,6 @@ the [Rust Community Discord]. I go by `@lone_scientist` there.
[examples]: https://github.com/hecrj/iced/tree/master/examples [examples]: https://github.com/hecrj/iced/tree/master/examples
[Coffee]: https://github.com/hecrj/coffee [Coffee]: https://github.com/hecrj/coffee
[Elm]: https://elm-lang.org/ [Elm]: https://elm-lang.org/
[`stretch`]: https://github.com/vislyhq/stretch
[`nalgebra`]: https://github.com/rustsim/nalgebra
[The Elm Architecture]: https://guide.elm-lang.org/architecture/ [The Elm Architecture]: https://guide.elm-lang.org/architecture/
[issues]: https://github.com/hecrj/iced/issues [issues]: https://github.com/hecrj/iced/issues
[Rust Community Discord]: https://bit.ly/rust-community [Rust Community Discord]: https://bit.ly/rust-community