djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Emil Ernerfeldt 2020-08-28 16:22:36 +02:00
parent b8938e01c4
commit 0755a95c76
2 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,11 +1,19 @@
# Egui # Egui
An immediate mode GUI library for Rust. Egui works anywhere you can draw textured triangles. Highly portable immediate mode GUI library for Rust.
Simple, fast, work in progress
Made for games or for anyone who want to make their own GUI and share it easily on a web page or compile it natively.
Egui can be used anywhere you can draw textured triangles.
[![Latest version](https://img.shields.io/crates/v/egui.svg)](https://crates.io/crates/egui) [![Latest version](https://img.shields.io/crates/v/egui.svg)](https://crates.io/crates/egui)
[![Documentation](https://docs.rs/egui/badge.svg)](https://docs.rs/egui) [![Documentation](https://docs.rs/egui/badge.svg)](https://docs.rs/egui)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg) ![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![Apache](https://img.shields.io/badge/license-Apache-blue.svg) ![Apache](https://img.shields.io/badge/license-Apache-blue.svg)
Sections: Sections:
* [Demo](#demos) * [Demo](#demos)
* [Goals](#goals) * [Goals](#goals)
@ -37,12 +45,12 @@ Window::new("Debug").show(ui.ctx(), |ui| {
## Goals ## Goals
* Short and convenient syntax * API: Simple and convenient
* Responsive: 60 Hz without breaking a sweat * Responsive: target 60 Hz in debug build
* Portable: the same code works on the web and as a native app * Portable: the same code works on the web and as a native app
* Safe: difficult to make a mistake * Friendly: difficult to make mistakes
* Easy to integrate into a any environment * Easy to integrate into a any environment
* Provide a simple 2D graphics API for custom painting * A simple 2D graphics API for custom painting
* Simple: no callbacks, minimal dependencies, avoid unnecessary monomorphization * Simple: no callbacks, minimal dependencies, avoid unnecessary monomorphization
Egui is *not* a framework. Egui is a library you call into, not an environment you program for. Egui is *not* a framework. Egui is a library you call into, not an environment you program for.
@ -56,7 +64,7 @@ Alpha state. It works well for what it does, but it lacks many features and the
* Widgets: label, text button, hyperlink, checkbox, radio button, slider, draggable value, text editing * Widgets: label, text button, hyperlink, checkbox, radio button, slider, draggable value, text editing
* Layouts: horizontal, vertical, columns * Layouts: horizontal, vertical, columns
* Text input: very basic, multiline, copy/paste * Text input: very basic, multiline, copy/paste
* Windows: move, resize, name, minimize and close * Windows: move, resize, name, minimize and close. Automatically sized and positioned.
* Regions: resizing, vertical scrolling, collapsing headers (sections) * Regions: resizing, vertical scrolling, collapsing headers (sections)
* Rendering: Anti-aliased rendering of lines, circles, text and convex polygons. * Rendering: Anti-aliased rendering of lines, circles, text and convex polygons.
* Tooltips on hover * Tooltips on hover

1
egui/README.md
View file

@ -96,6 +96,7 @@ Add extremely quick animations for some things, maybe 2-3 frames. For instance:
* [ ] Draw as hotmap * [ ] Draw as hotmap
* [ ] Change `width.min(max_width)` to `width.at_most(max_width)` * [ ] Change `width.min(max_width)` to `width.at_most(max_width)`
* [ ] Egui icon * [ ] Egui icon
* [ ] Minimal markdown viewer
### Names and structure ### Names and structure
* [ ] Rename things to be more consistent with Dear ImGui * [ ] Rename things to be more consistent with Dear ImGui