Skip to content

Commit

Permalink
fix links to demo
Browse files Browse the repository at this point in the history
  • Loading branch information
tguichaoua committed Nov 23, 2024
1 parent 83a3006 commit 94e4def
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ an SDK for visualizing streams of multimodal data.

---

👉 [Click to run the web demo](https://www.egui.rs/#demo) 👈
👉 [Click to run the web demo](https://www.egui.rs/#Demo) 👈

egui (pronounced "e-gooey") is a simple, fast, and highly portable immediate mode GUI library for Rust. egui runs on the web, natively, and [in your favorite game engine](#integrations).

Expand Down Expand Up @@ -68,15 +68,15 @@ ui.image(egui::include_image!("ferris.png"));

## Quick start

There are simple examples in [the `examples/` folder](https://github.com/emilk/egui/blob/master/examples/). If you want to write a web app, then go to <https://github.com/emilk/eframe_template/> and follow the instructions. The official docs are at <https://docs.rs/egui>. For inspiration and more examples, check out the [the egui web demo](https://www.egui.rs/#demo) and follow the links in it to its source code.
There are simple examples in [the `examples/` folder](https://github.com/emilk/egui/blob/master/examples/). If you want to write a web app, then go to <https://github.com/emilk/eframe_template/> and follow the instructions. The official docs are at <https://docs.rs/egui>. For inspiration and more examples, check out the [the egui web demo](https://www.egui.rs/#Demo) and follow the links in it to its source code.

If you want to integrate egui into an existing engine, go to the [Integrations](#integrations) section.

If you have questions, use [GitHub Discussions](https://github.com/emilk/egui/discussions). There is also [an egui discord server](https://discord.gg/JFcEma9bJq). If you want to contribute to egui, please read the [Contributing Guidelines](https://github.com/emilk/egui/blob/master/CONTRIBUTING.md).

## Demo

[Click to run egui web demo](https://www.egui.rs/#demo) (works in any browser with Wasm and WebGL support). Uses [`eframe`](https://github.com/emilk/egui/tree/master/crates/eframe).
[Click to run egui web demo](https://www.egui.rs/#Demo) (works in any browser with Wasm and WebGL support). Uses [`eframe`](https://github.com/emilk/egui/tree/master/crates/eframe).

To test the demo app locally, run `cargo run --release -p egui_demo_app`.

Expand Down Expand Up @@ -301,7 +301,7 @@ If you call `.await` in your GUI code, the UI will freeze, which is very bad UX.
The async version of [rfd](https://docs.rs/rfd/latest/rfd/) supports both native and Wasm. See example app here https://github.com/woelper/egui_pick_file which also has a demo available via [gitub pages](https://woelper.github.io/egui_pick_file/).

### What about accessibility, such as screen readers?
egui includes optional support for [AccessKit](https://accesskit.dev/), which currently implements the native accessibility APIs on Windows and macOS. This feature is enabled by default in eframe. For platforms that AccessKit doesn't yet support, including web, there is an experimental built-in screen reader; in [the web demo](https://www.egui.rs/#demo) you can enable it in the "Backend" tab.
egui includes optional support for [AccessKit](https://accesskit.dev/), which currently implements the native accessibility APIs on Windows and macOS. This feature is enabled by default in eframe. For platforms that AccessKit doesn't yet support, including web, there is an experimental built-in screen reader; in [the web demo](https://www.egui.rs/#Demo) you can enable it in the "Backend" tab.

The original discussion of accessibility in egui is at <https://github.com/emilk/egui/issues/167>. Now that AccessKit support is merged, providing a strong foundation for future accessibility work, please open new issues on specific accessibility problems.

Expand Down
2 changes: 1 addition & 1 deletion crates/egui/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ There are no stand-alone egui examples, because egui is not stand-alone!

See the top-level [examples](https://github.com/emilk/egui/tree/master/examples/) folder instead.

There are also plenty of examples in [the online demo](https://www.egui.rs/#demo). You can find the source code for it at <https://github.com/emilk/egui/tree/master/crates/egui_demo_lib>.
There are also plenty of examples in [the online demo](https://www.egui.rs/#Demo). You can find the source code for it at <https://github.com/emilk/egui/tree/master/crates/egui_demo_lib>.

To learn how to set up `eframe` for web and native, go to <https://github.com/emilk/eframe_template/> and follow the instructions there!
6 changes: 3 additions & 3 deletions crates/egui/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! `egui`: an easy-to-use GUI in pure Rust!
//!
//! Try the live web demo: <https://www.egui.rs/#demo>. Read more about egui at <https://github.com/emilk/egui>.
//! Try the live web demo: <https://www.egui.rs/#Demo>. Read more about egui at <https://github.com/emilk/egui>.
//!
//! `egui` is in heavy development, with each new version having breaking changes.
//! You need to have rust 1.77.0 or later to use `egui`.
Expand All @@ -18,7 +18,7 @@
//!
//! # Using egui
//!
//! To see what is possible to build with egui you can check out the online demo at <https://www.egui.rs/#demo>.
//! To see what is possible to build with egui you can check out the online demo at <https://www.egui.rs/#Demo>.
//!
//! If you like the "learning by doing" approach, clone <https://github.com/emilk/eframe_template> and get started using egui right away.
//!
Expand Down Expand Up @@ -591,7 +591,7 @@ pub(crate) const MINUS_CHAR_STR: &str = "−";
///
/// NOTE: In egui all emojis are monochrome!
///
/// You can explore them all in the Font Book in [the online demo](https://www.egui.rs/#demo).
/// You can explore them all in the Font Book in [the online demo](https://www.egui.rs/#Demo).
///
/// In addition, egui supports a few special emojis that are not part of the unicode standard.
/// This module contains some of them:
Expand Down
2 changes: 1 addition & 1 deletion web_demo/example.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<head>
<meta http-equiv="refresh" content="0; url = https://www.egui.rs/#http" />
<meta http-equiv="refresh" content="0; url = https://www.egui.rs/#Http" />
</head>

<body>
Expand Down

0 comments on commit 94e4def

Please sign in to comment.