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

Add logo to README 🎉

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2021-08-27 17:04:29 +07:00
parent 6821114cae
commit 9ab6923e94
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
2 changed files with 34 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,4 +1,9 @@
# Iced
<div align="center">
<img src="docs/logo.svg" width="140px" />
# iced
[![Test Status](https://github.com/hecrj/iced/workflows/Test/badge.svg?event=push)](https://github.com/hecrj/iced/actions)
[![Documentation](https://docs.rs/iced/badge.svg)][documentation]
[![Crates.io](https://img.shields.io/crates/v/iced.svg)](https://crates.io/crates/iced)
@ -8,13 +13,13 @@
A cross-platform GUI library for Rust focused on simplicity and type-safety.
Inspired by [Elm].
<div align="center">
<a href="https://gfycat.com/littlesanehalicore">
<img src="https://thumbs.gfycat.com/LittleSaneHalicore-small.gif" height="350px">
</a>
<a href="https://gfycat.com/politeadorableiberianmole">
<img src="https://thumbs.gfycat.com/PoliteAdorableIberianmole-small.gif">
</a>
<a href="https://gfycat.com/littlesanehalicore">
<img src="https://thumbs.gfycat.com/LittleSaneHalicore-small.gif" height="350px">
</a>
<a href="https://gfycat.com/politeadorableiberianmole">
<img src="https://thumbs.gfycat.com/PoliteAdorableIberianmole-small.gif">
</a>
</div>
## Features
@ -32,7 +37,7 @@ Inspired by [Elm].
* A [windowing shell]
* A [web runtime] leveraging the DOM
__Iced is currently experimental software.__ [Take a look at the roadmap],
__iced is currently experimental software.__ [Take a look at the roadmap],
[check out the issues], and [feel free to contribute!]
[Cross-platform support]: https://github.com/hecrj/iced/blob/master/docs/images/todos_desktop.jpg?raw=true
@ -58,13 +63,13 @@ Add `iced` as a dependency in your `Cargo.toml`:
iced = "0.3"
```
__Iced moves fast and the `master` branch can contain breaking changes!__ If
__iced moves fast and the `master` branch can contain breaking changes!__ If
you want to learn about a specific release, check out [the release list].
[the release list]: https://github.com/hecrj/iced/releases
## 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:
* __State__ — the state of your application
@ -154,7 +159,7 @@ impl Counter {
}
```
And that's everything! We just wrote a whole user interface. Iced is now able
And that's everything! We just wrote a whole user interface. iced is now able
to:
1. Take the result of our __view logic__ and layout its widgets.
@ -165,7 +170,7 @@ to:
Browse the [documentation] and the [examples] to learn more!
## 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 core of the library was implemented during May 2019 in [this pull request].
@ -178,7 +183,7 @@ end-user-oriented GUI library, while keeping [the ecosystem] modular:
<p align="center">
<a href="https://github.com/hecrj/iced/blob/master/ECOSYSTEM.md">
<img alt="Iced Ecosystem" src="docs/graphs/ecosystem.png" width="80%">
<img alt="iced ecosystem" src="docs/graphs/ecosystem.png" width="80%">
</a>
</p>
@ -199,7 +204,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.
## 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/
[examples]: https://github.com/hecrj/iced/tree/master/examples