Add installation section to subcrate README
s
This commit is contained in:
parent
cb4827059f
commit
4b94cf0035
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "iced"
|
||||
version = "0.1.0-alpha.1"
|
||||
version = "0.1.0-beta"
|
||||
authors = ["Héctor Ramón Jiménez <hector0193@gmail.com>"]
|
||||
edition = "2018"
|
||||
description = "A cross-platform GUI library inspired by Elm"
|
||||
@ -29,7 +29,7 @@ members = [
|
||||
|
||||
[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
|
||||
iced_winit = { version = "0.1.0-alpha", path = "winit" }
|
||||
iced_wgpu = { version = "0.1.0-alpha", path = "wgpu" }
|
||||
iced_wgpu = { version = "0.1.0", path = "wgpu" }
|
||||
|
||||
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
||||
iced_web = { version = "0.1.0-alpha", path = "web" }
|
||||
|
@ -27,8 +27,9 @@ Inspired by [Elm].
|
||||
* [Debug overlay with performance metrics]
|
||||
* First-class support for async actions (use futures!)
|
||||
* [Modular ecosystem] split into reusable parts:
|
||||
* A [default renderer] supporting Vulkan, Metal, DX11, and DX12
|
||||
* A [renderer-agnostic native runtime] enabling integration with existing systems
|
||||
* A [built-in renderer] supporting Vulkan, Metal, DX11, and DX12
|
||||
* A [windowing shell]
|
||||
* A [web runtime] leveraging the DOM
|
||||
|
||||
__Iced is currently experimental software.__ [Take a look at the roadmap],
|
||||
@ -41,7 +42,8 @@ __Iced is currently experimental software.__ [Take a look at the roadmap],
|
||||
[Modular ecosystem]: https://github.com/hecrj/iced/blob/master/ECOSYSTEM.md
|
||||
[renderer-agnostic native runtime]: https://github.com/hecrj/iced/tree/master/native
|
||||
[`wgpu`]: https://github.com/gfx-rs/wgpu-rs
|
||||
[Default renderer]: https://github.com/hecrj/iced/tree/master/wgpu
|
||||
[built-in renderer]: https://github.com/hecrj/iced/tree/master/wgpu
|
||||
[windowing shell]: https://github.com/hecrj/iced/tree/master/winit
|
||||
[`dodrio`]: https://github.com/fitzgen/dodrio
|
||||
[web runtime]: https://github.com/hecrj/iced/tree/master/web
|
||||
[Take a look at the roadmap]: https://github.com/hecrj/iced/blob/master/ROADMAP.md
|
||||
@ -52,7 +54,7 @@ __Iced is currently experimental software.__ [Take a look at the roadmap],
|
||||
Add `iced` as a dependency in your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
iced = "0.1"
|
||||
iced = "0.1.0-beta"
|
||||
```
|
||||
|
||||
__Iced moves fast and the `master` branch can contain breaking changes!__ If
|
||||
|
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "iced_core"
|
||||
version = "0.1.0-alpha"
|
||||
version = "0.1.0"
|
||||
authors = ["Héctor Ramón Jiménez <hector0193@gmail.com>"]
|
||||
edition = "2018"
|
||||
description = "The essential concepts of Iced"
|
||||
|
@ -11,3 +11,15 @@ This crate is meant to be a starting point for an Iced runtime.
|
||||

|
||||
|
||||
[documentation]: https://docs.rs/iced_core
|
||||
|
||||
## Installation
|
||||
Add `iced_core` as a dependency in your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
iced_core = "0.1.0"
|
||||
```
|
||||
|
||||
__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
|
||||
|
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "iced_native"
|
||||
version = "0.1.0-alpha"
|
||||
version = "0.1.0"
|
||||
authors = ["Héctor Ramón Jiménez <hector0193@gmail.com>"]
|
||||
edition = "2018"
|
||||
description = "A renderer-agnostic library for native GUIs"
|
||||
@ -8,6 +8,6 @@ license = "MIT"
|
||||
repository = "https://github.com/hecrj/iced"
|
||||
|
||||
[dependencies]
|
||||
iced_core = { version = "0.1.0-alpha", path = "../core", features = ["command"] }
|
||||
iced_core = { version = "0.1.0", path = "../core", features = ["command"] }
|
||||
twox-hash = "1.5"
|
||||
raw-window-handle = "0.3"
|
||||
|
@ -21,3 +21,15 @@ To achieve this, it introduces a bunch of reusable interfaces:
|
||||
[`iced_winit`]: ../winit
|
||||
[`druid`]: https://github.com/xi-editor/druid
|
||||
[`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle
|
||||
|
||||
## Installation
|
||||
Add `iced_native` as a dependency in your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
iced_native = "0.1.0"
|
||||
```
|
||||
|
||||
__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
|
||||
|
@ -13,3 +13,15 @@ The crate is currently a __very experimental__, simple abstraction layer over [`
|
||||
[documentation]: https://docs.rs/iced_web
|
||||
[`iced_core`]: ../core
|
||||
[`dodrio`]: https://github.com/fitzgen/dodrio
|
||||
|
||||
## Installation
|
||||
Add `iced_web` as a dependency in your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
iced_web = "0.1.0-alpha"
|
||||
```
|
||||
|
||||
__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
|
||||
|
@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "iced_wgpu"
|
||||
version = "0.1.0-alpha"
|
||||
version = "0.1.0"
|
||||
authors = ["Héctor Ramón Jiménez <hector0193@gmail.com>"]
|
||||
edition = "2018"
|
||||
description = "A wgpu renderer for Iced"
|
||||
@ -8,7 +8,7 @@ license = "MIT"
|
||||
repository = "https://github.com/hecrj/iced"
|
||||
|
||||
[dependencies]
|
||||
iced_native = { version = "0.1.0-alpha", path = "../native" }
|
||||
iced_native = { version = "0.1.0", path = "../native" }
|
||||
wgpu = "0.4"
|
||||
glyph_brush = "0.6"
|
||||
wgpu_glyph = { version = "0.5", git = "https://github.com/hecrj/wgpu_glyph", branch = "feature/scissoring" }
|
||||
|
@ -22,6 +22,18 @@ Currently, `iced_wgpu` supports the following primitives:
|
||||
[WebGPU API]: https://gpuweb.github.io/gpuweb/
|
||||
[`wgpu_glyph`]: https://github.com/hecrj/wgpu_glyph
|
||||
|
||||
## Installation
|
||||
Add `iced_wgpu` as a dependency in your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
iced_wgpu = "0.1.0"
|
||||
```
|
||||
|
||||
__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
|
||||
|
||||
## Current limitations
|
||||
|
||||
The current implementation is quite naive, it uses:
|
||||
|
@ -13,3 +13,15 @@ It exposes a renderer-agnostic `Application` trait that can be implemented and t
|
||||
[documentation]: https://docs.rs/iced_winit
|
||||
[`iced_native`]: ../native
|
||||
[`winit`]: https://github.com/rust-windowing/winit
|
||||
|
||||
## Installation
|
||||
Add `iced_winit` as a dependency in your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
iced_winit = "0.1.0-alpha"
|
||||
```
|
||||
|
||||
__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
|
||||
|
Loading…
Reference in New Issue
Block a user