From 235d77713d47a439587578f8e10a7aeffbca4d2c Mon Sep 17 00:00:00 2001 From: Emil Ernerfeldt Date: Fri, 29 Jul 2022 16:07:48 +0200 Subject: [PATCH] Improve README.md files --- eframe/README.md | 2 ++ egui-winit/README.md | 2 +- egui_demo_app/README.md | 4 ++++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/eframe/README.md b/eframe/README.md index a6e4ef9f..1d5e95af 100644 --- a/eframe/README.md +++ b/eframe/README.md @@ -33,6 +33,8 @@ You can opt-in to the using [`egui_wgpu`](https://github.com/emilk/egui/tree/mas ## Alternatives `eframe` is not the only way to write an app using `egui`! You can also try [`egui-miniquad`](https://github.com/not-fl3/egui-miniquad), [`bevy_egui`](https://github.com/mvlabat/bevy_egui), [`egui_sdl2_gl`](https://github.com/ArjunNair/egui_sdl2_gl), and others. +You can also use `egui_glow` and [`winit`](https://github.com/rust-windowing/winit) to build your own app as demonstrated in . + ## Problems with running egui on the web `eframe` uses WebGL (via [`glow`](https://crates.io/crates/glow)) and WASM, and almost nothing else from the web tech stack. This has some benefits, but also produces some challenges and serious downsides. diff --git a/egui-winit/README.md b/egui-winit/README.md index 07eb28ff..1f2c7d17 100644 --- a/egui-winit/README.md +++ b/egui-winit/README.md @@ -6,6 +6,6 @@ ![MIT](https://img.shields.io/badge/license-MIT-blue.svg) ![Apache](https://img.shields.io/badge/license-Apache-blue.svg) -This crates provides bindings between [`egui`](https://github.com/emilk/egui) and [winit](https://crates.io/crates/winit). +This crates provides bindings between [`egui`](https://github.com/emilk/egui) and [`winit`](https://crates.io/crates/winit). The library translates winit events to egui, handled copy/paste, updates the cursor, open links clicked in egui, etc. diff --git a/egui_demo_app/README.md b/egui_demo_app/README.md index 0eb6d831..472618ec 100644 --- a/egui_demo_app/README.md +++ b/egui_demo_app/README.md @@ -13,3 +13,7 @@ Run it locally with `cargo run --release -p egui_demo_app`. ``` `egui_demo_app` uses [`egui_demo_lib`](https://github.com/emilk/egui/tree/master/egui_demo_lib). + + +## Running with `wgpu` backend +`(cd egui_demo_app && cargo r --features wgpu)`