From e8595218ef5de6103ce1e4ceacd3b7f3f3f2b40e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Ram=C3=B3n=20Jim=C3=A9nez?= Date: Fri, 22 Nov 2019 22:21:37 +0100 Subject: [PATCH] Finish `iced_native` usage section --- native/src/lib.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) 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)]