summaryrefslogtreecommitdiffstats
path: root/native/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-22 22:21:37 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-22 22:21:37 +0100
commite8595218ef5de6103ce1e4ceacd3b7f3f3f2b40e (patch)
tree75a34dd5cd0894fd746b5e86b127c6f036f60223 /native/src/lib.rs
parent580891dda76f7e9174913eb75e3bee4261866d71 (diff)
downloadiced-e8595218ef5de6103ce1e4ceacd3b7f3f3f2b40e.tar.gz
iced-e8595218ef5de6103ce1e4ceacd3b7f3f3f2b40e.tar.bz2
iced-e8595218ef5de6103ce1e4ceacd3b7f3f3f2b40e.zip
Finish `iced_native` usage section
Diffstat (limited to 'native/src/lib.rs')
-rw-r--r--native/src/lib.rs8
1 files changed, 7 insertions, 1 deletions
diff --git a/native/src/lib.rs b/native/src/lib.rs
index 4680cbe1..45c3c699 100644
--- a/native/src/lib.rs
+++ b/native/src/lib.rs
@@ -19,7 +19,12 @@
//! shells (like [`iced_winit`]) can use this trait to stay renderer-agnostic.
//!
//! # Usage
-//! Check out the [`UserInterface`] type to learn how to wire everything up!
+//! The strategy to use this crate depends on your particular use case. If you
+//! want to:
+//! - Implement a custom shell or integrate it in your own system, you should
+//! check out the [`UserInterface`] type.
+//! - Build a new renderer, see the [renderer] module.
+//! - Build a custom widget, start at the [`Widget`] trait.
//!
//! [`iced_core`]: https://github.com/hecrj/iced/tree/master/core
//! [`iced_winit`]: https://github.com/hecrj/iced/tree/master/winit
@@ -28,6 +33,7 @@
//! [`Widget`]: widget/trait.Widget.html
//! [`Windowed`]: renderer/trait.Windowed.html
//! [`UserInterface`]: struct.UserInterface.html
+//! [renderer]: renderer/index.html
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
#![deny(unused_results)]