From 1be828bbe35e3928679a0636efee5642251fb118 Mon Sep 17 00:00:00 2001 From: Emil Ernerfeldt Date: Sun, 19 Apr 2020 11:15:35 +0200 Subject: [PATCH] Remove roadmap and replace with emigui/README.md with a TODO section --- README.md | 6 +----- emigui/README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 emigui/README.md diff --git a/README.md b/README.md index 1e4891fc..e2b300ff 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,9 @@ Features: * Collapsible headers (sections) * Anti-aliased rendering of circles, rounded rectangles and lines. -## Roadmap: -* Turn the [Glium](https://github.com/glium/glium) backend into a library -* Some examples and documentation -* Text input ## Inspiration -[Dear ImGui](https://github.com/ocornut/imgui) is a great Immediate Mode GUI for C++ which works with many backends. +The one and only [Dear ImGui](https://github.com/ocornut/imgui) is a great Immediate Mode GUI for C++ which works with many backends. That library revolutionized how I think about GUI code from something I hated to do to something I now like to do. ## Credits / Licenses Fonts: diff --git a/emigui/README.md b/emigui/README.md new file mode 100644 index 00000000..12d7f04c --- /dev/null +++ b/emigui/README.md @@ -0,0 +1,16 @@ +# GUI implementation +This is the core library crate Emigui. It is fully platform independent without any backend. You give the Emigui library input each frame (mouse pos etc), and it outputs a triangle mesh for you to paint. + +## TODO: +* Widgets: + * Movable/resizable windows + * Scroll areas (requires scissor tests / clip rects in paint backend) + * Menu bar (File, Edit, etc) + * One-line text input + * Color picker + * Style editor + * Persist UI state in external storage +* Rename Region to something shorter? + * `region: &Region` `region.add(...)` :/ + * `gui: &Gui` `gui.add(...)` :) + * `ui: &Ui` `ui.add(...)` :)