diff --git a/eframe/README.md b/eframe/README.md index 1c452a6df..0d8908a84 100644 --- a/eframe/README.md +++ b/eframe/README.md @@ -10,6 +10,10 @@ To get started, go to and follow the instructions there! +You can also take a look at [the `eframe` examples folder](https://github.com/emilk/egui/tree/master/eframe/examples). There is also an excellent tutorial video at . + +For how to use `egui`, see [the egui docs](https://docs.rs/egui). + --- `eframe` is a very thin crate that re-exports [`egui`](https://github.com/emilk/egui) and[`epi`](https://github.com/emilk/egui/tree/master/epi) with thin wrappers over the backends. @@ -34,7 +38,7 @@ eframe = { version = "*", default-features = false, features = ["default_fonts", ## Companion crates -Not all rust crates work when compiles to WASM, but here are some useful crates have been designed to work well both natively and as WASM: +Not all rust crates work when compiled to WASM, but here are some useful crates have been designed to work well both natively and as WASM: * Audio: [`cpal`](https://github.com/RustAudio/cpal). * HTTP client: [`ehttp`](https://github.com/emilk/ehttp). diff --git a/eframe/src/lib.rs b/eframe/src/lib.rs index ba4bda877..8e12791c4 100644 --- a/eframe/src/lib.rs +++ b/eframe/src/lib.rs @@ -6,6 +6,8 @@ //! //! To get started, look at . //! +//! You can also take a look at [the `eframe` examples folder](https://github.com/emilk/egui/tree/master/eframe/examples). +//! //! You write your application code for [`epi`] (implementing [`epi::App`]) and then //! call from [`crate::run_native`] your `main.rs`, and/or call `eframe::start_web` from your `lib.rs`. //! diff --git a/egui/examples/README.md b/egui/examples/README.md new file mode 100644 index 000000000..44a9fe086 --- /dev/null +++ b/egui/examples/README.md @@ -0,0 +1,5 @@ +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 . + +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/). diff --git a/egui_demo_lib/README.md b/egui_demo_lib/README.md index ceb51b1f8..3772c953d 100644 --- a/egui_demo_lib/README.md +++ b/egui_demo_lib/README.md @@ -8,7 +8,8 @@ This crate contains example code for [`egui`](https://github.com/emilk/egui). -It is in a separate crate for two reasons: +The demo library is a separate crate for three reasons: * To ensure it only uses the public `egui` api. * To remove the amount of code in `egui` proper. +* To make it easy for other integrations to use the egui demos a test. diff --git a/epaint/src/text/fonts.rs b/epaint/src/text/fonts.rs index 806e8fe93..2ea3841f4 100644 --- a/epaint/src/text/fonts.rs +++ b/epaint/src/text/fonts.rs @@ -56,7 +56,7 @@ pub enum FontFamily { #[derive(Clone, Debug, PartialEq)] #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))] pub struct FontData { - /// The data of a `.ttf` or `.otf` file. + /// The content of a `.ttf` or `.otf` file. pub font: std::borrow::Cow<'static, [u8]>, /// Which font face in the file to use. /// When in doubt, use `0`.