Improve README files for all crates
This commit is contained in:
Emil Ernerfeldt
parent
326da7a0d7
commit
4feee59f84
5 changed files with 40 additions and 15 deletions
|
|
@ -294,7 +294,7 @@ There is experimental support for a screen reader. In [the web demo](https://emi
|
|||
|
||||
Read more at <https://github.com/emilk/egui/issues/167>.
|
||||
|
||||
### What is the difference between [egui](https://docs.rs/egui) and [eframe](https://docs.rs/eframe)?
|
||||
### What is the difference between [egui](https://docs.rs/egui) and [eframe](https://github.com/emilk/egui/tree/master/eframe)?
|
||||
|
||||
`egui` is a 2D user interface library for laying out and interacting with buttons, sliders, etc.
|
||||
`egui` has no idea if it is running on the web or natively, and does not know how to collect input or show things on screen.
|
||||
|
|
@ -308,7 +308,7 @@ The _frame_ in `eframe` stands both for the frame in which your egui app resides
|
|||
On Linux and Mac, Firefox will copy the WebGL render target from GPU, to CPU and then back again: https://bugzilla.mozilla.org/show_bug.cgi?id=1010527#c0
|
||||
|
||||
### Why does my web app not fill the full width of the screen?
|
||||
To alleviate the above mentioned performance issues the default max-width of an egui web app is 1024 points. You can change this by ovveriding the `fn max_size_points` of `epi::App`.
|
||||
To alleviate the above mentioned performance issues the default max-width of an egui web app is 1024 points. You can change this by ovveriding the `fn max_size_points` of [`epi::App`](https://docs.rs/epi/latest/epi/trait.App.html).
|
||||
|
||||
|
||||
## Other
|
||||
|
|
|
|||
|
|
@ -1,13 +1,24 @@
|
|||
# egui framework
|
||||
# eframe: the [`egui`](https://github.com/emilk/egui) framework
|
||||
|
||||
This aims to be the entry-level crate if you want to write an egui app.
|
||||
[](https://crates.io/crates/eframe)
|
||||
[](https://docs.rs/eframe)
|
||||
[](https://github.com/rust-secure-code/safety-dance/)
|
||||
|
||||
|
||||
|
||||
|
||||
This aims to be the entry-level crate if you want to write an `egui` app.
|
||||
|
||||
`eframe` calls into your code (it is a framework) and supports web apps (via [`egui_web`](https://crates.io/crates/egui_web)) and native apps (via [`egui_glium`](https://crates.io/crates/egui_glium)).
|
||||
|
||||
`eframe` is a very thin crate that re-exports [`egui`](https://crates.io/crates/egui), [`epi`](https://crates.io/crates/epi) and thin wrappers over the backends.
|
||||
`eframe` is a very thin crate that re-exports [`egui`](https://github.com/emilk/egui), [`epi`](https://github.com/emilk/egui/tree/master/epi) and thin wrappers over the backends.
|
||||
|
||||
On Linux you need to first run `sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev` to compile `eframe` natively.
|
||||
To use on Linux, first run:
|
||||
|
||||
```
|
||||
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev
|
||||
```
|
||||
|
||||
## Name
|
||||
|
||||
The _frame_ in `eframe` stands both for the frame in which your egui app resides and also for "framework" (`frame` is a framework, `egui` is a library).
|
||||
The _frame_ in `eframe` stands both for the frame in which your `egui` app resides and also for "framework" (`frame` is a framework, `egui` is a library).
|
||||
|
|
|
|||
|
|
@ -1,10 +1,15 @@
|
|||
# egui_glium
|
||||
|
||||
[](https://crates.io/crates/egui_glium)
|
||||
[](https://docs.rs/egui_glium)
|
||||
[](https://github.com/rust-secure-code/safety-dance/)
|
||||
|
||||
|
||||
|
||||
# egui_glium
|
||||
This crates provides bindings between [`egui`](https://github.com/emilk/egui) and [glium](https://crates.io/crates/glium) which allows you to write GUI code using egui and compile it and run it natively, cross platform.
|
||||
|
||||
This crates provides bindings between [egui](https://crates.io/crates/egui) and [glium](https://crates.io/crates/glium) which allows you to write GUI code using egui and compile it and run it natively, cross platform.
|
||||
To use on Linux, first run:
|
||||
|
||||
For linux you need to `sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev` to use `egui_glium`.
|
||||
```
|
||||
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
# egui_web
|
||||
|
||||
[](https://crates.io/crates/egui_web)
|
||||
[](https://docs.rs/egui_web)
|
||||
[](https://github.com/rust-secure-code/safety-dance/)
|
||||
|
||||
|
||||
|
||||
# egui_web
|
||||
|
||||
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.
|
||||
|
||||
Check out [egui_template](https://github.com/emilk/egui_template) for an example of how to set it up.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,13 @@
|
|||
# egui app programming interface
|
||||
# `epi`: the [`egui`](https://github.com/emilk/egui) application programming interface
|
||||
|
||||
Backend-agnostic interface for writing apps using [`egui`](https://crates.io/crates/egui) (a platform agnostic GUI library).
|
||||
[](https://crates.io/crates/epi)
|
||||
[](https://docs.rs/epi)
|
||||
[](https://github.com/rust-secure-code/safety-dance/)
|
||||
|
||||
|
||||
|
||||
This crate provides a common interface for programming an app using egui, which can then be easily plugged into [`egui_frame`](https://crates.io/crates/egui_frame) (which in a wrapper over [`egui_web`](https://crates.io/crates/egui_web) or [`egui_glium`](https://crates.io/crates/egui_glium)).
|
||||
`epi` is a backend-agnostic interface for writing apps using `egui` (a platform agnostic GUI library).
|
||||
|
||||
This crate provides a common interface for programming an app using egui, which can then be easily plugged into [`eframe`](https://github.com/emilk/egui/tree/master/eframe) (which in a wrapper over [`egui_web`](https://crates.io/crates/egui_web) and/or [`egui_glium`](https://crates.io/crates/egui_glium)).
|
||||
|
||||
This crate is only for those that want to write an app that can be compiled both natively and for the web.
|
||||
|
|
|
|||
Loading…
Reference in a new issue