diff --git a/README.md b/README.md index 56d2eab2..7653a9d7 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,46 @@ # Emigui -Experimental, Modularized Immediate mode Graphical User Interface +(Experimental, Modularized Immediate mode Graphical User Interface) -A GUI library written in Rust, compiled to WASM. Inspired by game tech. +An immediate mode GUI library written in Rust. Compiles to WASM. + +## Goals: +* Easy to use +* Platform independent (the same code should run on web and native) +* Responsive ## How it works: - Loop: * Gather input: mouse, touches, screen size, ... -* Run app code (Immediate Mode GUI) +* Run application code (Immediate Mode GUI) * Output is a triangle mesh * Render with WebGL ## Demos -[Emigui feature demo](https://emilk.github.io/emigui/index.html) +[Emigui feature demo](https://emilk.github.io/emigui/index.html), source: https://github.com/emilk/emigui/blob/master/example/src/app.rs -[Hobogo: A small game using Emigui](https://emilk.github.io/hobogo/index.html) +[Hobogo: A small game using Emigui](https://emilk.github.io/hobogo/index.html), source: https://github.com/emilk/hobogo ## State -More of a tech demo than anything else. Features: +Mostly a tech demo at this point. I hope to find time to work more on this in the future. + +Features: -* Buttons -* Sliders * Text +* Buttons, checkboxes, radio buttons and sliders * Horizontal or vertical layout -* Columns -* Collapsible headers +* Column layout +* Collapsible headers (sections) +* Anti-aliased rendering of circles, rounded rectangles and lines. + +## Roadmap: +* Native backend +* Some examples / documentation +* Text input ## Inspiration -[Dear ImGui](https://github.com/ocornut/imgui) +[Dear ImGui](https://github.com/ocornut/imgui) is a great Immediate Mode GUI for C++ which works with many backends. ## Credits / Licenses -ProggyClean.ttf, Copyright (c) 2004, 2005 Tristan Grimmer. MIT License. http://www.proggyfonts.net/ -Roboto-Regular.ttf: Apache License, Version 2.0 +Fonts: +* ProggyClean.ttf, Copyright (c) 2004, 2005 Tristan Grimmer. MIT License. http://www.proggyfonts.net/ +* Roboto-Regular.ttf: Apache License, Version 2.0