1
0
mirror of https://github.com/emilk/egui.git synced 2026-09-01 14:20:04 -04:00

Improve README files for all crates

This commit is contained in:
Emil Ernerfeldt
2021-07-29 22:04:20 +02:00
parent 326da7a0d7
commit 4feee59f84
5 changed files with 40 additions and 15 deletions

View File

@@ -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).
[![Latest version](https://img.shields.io/crates/v/epi.svg)](https://crates.io/crates/epi)
[![Documentation](https://docs.rs/epi/badge.svg)](https://docs.rs/epi)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![Apache](https://img.shields.io/badge/license-Apache-blue.svg)
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.