emilk.github.io -> www.egui.rs
This commit is contained in:
parent
b4be94df35
commit
532990d3dd
7 changed files with 13 additions and 13 deletions
|
@ -42,7 +42,7 @@ Puts an egui app inside a native window on your laptop. Paints the triangles tha
|
||||||
### `eframe`
|
### `eframe`
|
||||||
A wrapper around `egui_web` + `egui_glium`, so you can compile the same app for either web or native.
|
A wrapper around `egui_web` + `egui_glium`, so you can compile the same app for either web or native.
|
||||||
|
|
||||||
The demo that you can see at <https://emilk.github.io/egui/index.html> is using `eframe` to host the `egui`. The demo code is found in:
|
The demo that you can see at <https://www.egui.rs> is using `eframe` to host the `egui`. The demo code is found in:
|
||||||
|
|
||||||
### `egui_demo_lib`
|
### `egui_demo_lib`
|
||||||
Depends on `egui` + `epi`.
|
Depends on `egui` + `epi`.
|
||||||
|
|
10
README.md
10
README.md
|
@ -9,7 +9,7 @@
|
||||||

|

|
||||||
[](https://discord.gg/JFcEma9bJq)
|
[](https://discord.gg/JFcEma9bJq)
|
||||||
|
|
||||||
👉 [Click to run the web demo](https://emilk.github.io/egui/index.html) 👈
|
👉 [Click to run the web demo](https://www.egui.rs/#demo) 👈
|
||||||
|
|
||||||
egui 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) (or will soon).
|
egui 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) (or will soon).
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ ui.label(format!("Hello '{}', age {}", name, age));
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
If you just want to write a GUI application in Rust (for the web or for native), go to <https://github.com/emilk/eframe_template/> and follow the instructions there! The official docs are at <https://docs.rs/egui>. For inspiration, check out the [the egui web demo](https://emilk.github.io/egui/index.html) and follow the links in it to its source code. There is also an excellent tutorial video at <https://www.youtube.com/watch?v=NtUkr_z7l84>.
|
If you just want to write a GUI application in Rust (for the web or for native), go to <https://github.com/emilk/eframe_template/> and follow the instructions there! The official docs are at <https://docs.rs/egui>. For inspiration, check out the [the egui web demo](https://www.egui.rs/#demo) and follow the links in it to its source code. There is also an excellent tutorial video at <https://www.youtube.com/watch?v=NtUkr_z7l84>.
|
||||||
|
|
||||||
If you want to integrate egui into an existing engine, go to the [Integrations](#integrations) section.
|
If you want to integrate egui into an existing engine, go to the [Integrations](#integrations) section.
|
||||||
|
|
||||||
|
@ -58,7 +58,7 @@ If you have questions, use [GitHub Discussions](https://github.com/emilk/egui/di
|
||||||
|
|
||||||
## Demo
|
## Demo
|
||||||
|
|
||||||
[Click to run egui web demo](https://emilk.github.io/egui/index.html) (works in any browser with WASM and WebGL support). Uses [`egui_web`](https://github.com/emilk/egui/tree/master/egui_web).
|
[Click to run egui web demo](https://www.egui.rs/#demo) (works in any browser with WASM and WebGL support). Uses [`egui_web`](https://github.com/emilk/egui/tree/master/egui_web).
|
||||||
|
|
||||||
To test the demo app locally, run `cargo run --release -p egui_demo_app`.
|
To test the demo app locally, run `cargo run --release -p egui_demo_app`.
|
||||||
|
|
||||||
|
@ -166,7 +166,7 @@ These are the official egui integrations:
|
||||||
|
|
||||||
* [`egui_glium`](https://github.com/emilk/egui/tree/master/egui_glium) for compiling native apps with [Glium](https://github.com/glium/glium).
|
* [`egui_glium`](https://github.com/emilk/egui/tree/master/egui_glium) for compiling native apps with [Glium](https://github.com/glium/glium).
|
||||||
* [`egui_glow`](https://github.com/emilk/egui/tree/master/egui_glow) for compiling native apps with [Glow](https://github.com/grovesNL/glow).
|
* [`egui_glow`](https://github.com/emilk/egui/tree/master/egui_glow) for compiling native apps with [Glow](https://github.com/grovesNL/glow).
|
||||||
* [`egui_web`](https://github.com/emilk/egui/tree/master/egui_web) for making a web app. Compiles to WASM, renders with WebGL. [Click to run the egui demo](https://emilk.github.io/egui/index.html).
|
* [`egui_web`](https://github.com/emilk/egui/tree/master/egui_web) for making a web app. Compiles to WASM, renders with WebGL. [Click to run the egui demo](https://www.egui.rs/#demo).
|
||||||
* [`egui-winit`](https://github.com/emilk/egui/tree/master/egui-winit) for integrating with [`winit`](https://github.com/rust-windowing/winit). `egui-winit` is used by `egui_glium` and `egui_glow`.
|
* [`egui-winit`](https://github.com/emilk/egui/tree/master/egui-winit) for integrating with [`winit`](https://github.com/rust-windowing/winit). `egui-winit` is used by `egui_glium` and `egui_glow`.
|
||||||
|
|
||||||
### 3rd party integrations
|
### 3rd party integrations
|
||||||
|
@ -305,7 +305,7 @@ Yes! But you need to install your own font (`.ttf` or `.otf`) using `Context::se
|
||||||
Yes! You can customize the colors, spacing and sizes of everything. By default egui comes with a dark and a light theme.
|
Yes! You can customize the colors, spacing and sizes of everything. By default egui comes with a dark and a light theme.
|
||||||
|
|
||||||
### What about accessibility, such as screen readers?
|
### What about accessibility, such as screen readers?
|
||||||
There is experimental support for a screen reader. In [the web demo](https://emilk.github.io/egui/index.html) you can enable it in the "Backend" tab.
|
There is experimental support for a screen reader. In [the web demo](https://www.egui.rs/#demo) you can enable it in the "Backend" tab.
|
||||||
|
|
||||||
Read more at <https://github.com/emilk/egui/issues/167>.
|
Read more at <https://github.com/emilk/egui/issues/167>.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
This folder contains the files required for the egui web demo hosted at <https://emilk.github.io/egui/>.
|
This folder contains the files required for the egui web demo hosted at <https://www.egui.rs/>.
|
||||||
|
|
||||||
The reason the folder is called "docs" is because that is the name that GitHub requires in order to host a web page from the `master` branch of a repository.
|
The reason the folder is called "docs" is because that is the name that GitHub requires in order to host a web page from the `master` branch of a repository.
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="refresh" content="0; url = https://emilk.github.io/egui/#http" />
|
<meta http-equiv="refresh" content="0; url = https://www.egui.rs/#http" />
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
There are no stand-alone egui examples, because egui is not stand-alone!
|
There are no stand-alone egui examples, because egui is not stand-alone!
|
||||||
|
|
||||||
There are plenty of examples in [the online demo](https://emilk.github.io/egui/). You can find the source code for it at <https://github.com/emilk/egui/tree/master/egui_demo_lib>.
|
There are 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/egui_demo_lib>.
|
||||||
|
|
||||||
If you are using `eframe`, check out [the `eframe` examples](https://github.com/emilk/egui/tree/master/eframe/examples) and [the `eframe` template repository](https://github.com/emilk/eframe_template/).
|
If you are using `eframe`, check out [the `eframe` examples](https://github.com/emilk/egui/tree/master/eframe/examples) and [the `eframe` template repository](https://github.com/emilk/eframe_template/).
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
//! `egui`: an easy-to-use GUI in pure Rust!
|
//! `egui`: an easy-to-use GUI in pure Rust!
|
||||||
//!
|
//!
|
||||||
//! Try the live web demo: <https://emilk.github.io/egui/index.html>. 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.
|
//! `egui` is in heavy development, with each new version having breaking changes.
|
||||||
//! You need to have rust 1.56.0 or later to use `egui`.
|
//! You need to have rust 1.56.0 or later to use `egui`.
|
||||||
|
@ -14,7 +14,7 @@
|
||||||
//!
|
//!
|
||||||
//! # Using egui
|
//! # Using egui
|
||||||
//!
|
//!
|
||||||
//! To see what is possible to build with egui you can check out the online demo at <https://emilk.github.io/egui/#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.
|
//! If you like the "learning by doing" approach, clone <https://github.com/emilk/eframe_template> and get started using egui right away.
|
||||||
//!
|
//!
|
||||||
|
@ -526,7 +526,7 @@ macro_rules! egui_assert {
|
||||||
///
|
///
|
||||||
/// NOTE: In egui all emojis are monochrome!
|
/// NOTE: In egui all emojis are monochrome!
|
||||||
///
|
///
|
||||||
/// You can explore them all in the Font Book in [the online demo](https://emilk.github.io/egui/).
|
/// 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.
|
/// In addition, egui supports a few special emojis that are not part of the unicode standard.
|
||||||
/// This module contains some of them:
|
/// This module contains some of them:
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
|
|
||||||
This crates allows you to compile GUI code written with [egui](https://crates.io/crates/egui) to [WASM](https://en.wikipedia.org/wiki/WebAssembly) to run on a web page.
|
This crates allows you to compile GUI code written with [egui](https://crates.io/crates/egui) to [WASM](https://en.wikipedia.org/wiki/WebAssembly) to run on a web page.
|
||||||
|
|
||||||
[Run the web demo](https://emilk.github.io/egui/index.html) to try it now.
|
[Run the web demo](https://www.egui.rs/#demo) to try it now.
|
||||||
|
|
||||||
Check out [eframe_template](https://github.com/emilk/eframe_template) for an example of how to set it up.
|
Check out [eframe_template](https://github.com/emilk/eframe_template) for an example of how to set it up.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue