migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-08-30 05:10:03 -04:00
Code Activity

Improve documentation

Browse Source
This commit is contained in:
Emil Ernerfeldt
2021-01-17 10:52:01 +01:00
parent 67c0fbdd01
commit 1f2aebc25a
15 changed files with 48 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
eframe/src/lib.rs
View File

@@ -1,11 +1,15 @@
//! eframe - the Egui Framework crate
//!
//! You write your application code for [`epi`] (implementing [`epi::App`]) and then
//! use eframe to either compile and run it natively, or compile it as a web app.
//! If you are planning to write an app for web or native,
//! and are happy with just using Egui for all visuals,
//! Then `eframe` is for you!
//!
//! To get started, look at <https://github.com/emilk/egui_template>.
//!
//! eframe is implemented using [`egui_web`](https://docs.rs/egui_web) and [`egui_glium`](https://docs.rs/egui_glium).
//! 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`.
//!
//! `eframe` is implemented using [`egui_web`](https://docs.rs/egui_web) and [`egui_glium`](https://docs.rs/egui_glium).
#![forbid(unsafe_code)]
#![cfg_attr(not(debug_assertions), deny(warnings))] // Forbid warnings in release builds
@@ -23,7 +27,7 @@ pub use egui_web::wasm_bindgen;
/// and start running the given app.
///
/// Usage:
/// ``` ignore
/// ``` no_run
/// #[cfg(target_arch = "wasm32")]
/// use wasm_bindgen::prelude::*;
///