summaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-03-17 13:55:15 +0100
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-03-17 13:55:15 +0100
commit179e8863b3c7a1f056eef5e06fbf4f3796a641ba (patch)
tree082451a3fa4cb432f21dd0f5fe8ad8969db92e4e /src/lib.rs
parent846d76cd3f3f2faae5efbb3fda2a2bcb3b064481 (diff)
downloadiced-179e8863b3c7a1f056eef5e06fbf4f3796a641ba.tar.gz
iced-179e8863b3c7a1f056eef5e06fbf4f3796a641ba.tar.bz2
iced-179e8863b3c7a1f056eef5e06fbf4f3796a641ba.zip
Fix broken intra-doc links to `Sandbox`
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs16
1 files changed, 12 insertions, 4 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 060cc6c5..1f2b8c93 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -134,8 +134,15 @@
//! }
//! ```
//!
-//! And that's everything! We just wrote a whole user interface. Iced is now
-//! able to:
+//! And that's everything! We just wrote a whole user interface. Let's run it:
+//!
+//! ```no_run
+//! fn main() -> iced::Result {
+//! iced::run("A cool counter", Counter::update, Counter::view)
+//! }
+//! ```
+//!
+//! Iced will automatically:
//!
//! 1. Take the result of our __view logic__ and layout its widgets.
//! 1. Process events from our system and produce __messages__ for our
@@ -143,11 +150,12 @@
//! 1. Draw the resulting user interface.
//!
//! # Usage
-//! The [`Application`] and [`Sandbox`] traits should get you started quickly,
-//! streamlining all the process described above!
+//! You can either use the [`application`] builder or implement the [`Application`]
+//! trait directly.
//!
//! [Elm]: https://elm-lang.org/
//! [The Elm Architecture]: https://guide.elm-lang.org/architecture/
+//! [`application`]: application()
#![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)]