From 5fd640415b9ae1be6ad0eba9e4c032bff3380321 Mon Sep 17 00:00:00 2001 From: Omar C Date: Sun, 10 Aug 2014 22:50:15 +0100 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e8b0fe31a..8d9b891bb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ -imgui +ImGui ===== -Immediate Mode Graphical User Interface with minimal dependencies. +ImGui is a bloat-free graphical user interface library for C/C++. It is portable, renderer agnostic and carries minimal amount of dependencies (only 3 files are needed). It is based on an "Immediate" graphical user interface paradigm which allows you to build simple user interfaces with ease. + +ImGui is designed to allow programmers to create "content creation" or "debug" tools (as opposed to tools for the average end-user). As thus, it is lacking certain features normally found in more high-level libraries, such as string localisation. + +A simple usage example: + +![screenshot of sample code alongside its output with ImGui](/web/code_sample_01.png?raw=true) + +Gallery +------- + +![screenshot 1](/web/test_window_01.png?raw=true) +![screenshot 2](/web/test_window_02.png?raw=true) +![screenshot 3](/web/test_window_03.png?raw=true) +![screenshot 4](/web/test_window_04.png?raw=true) + +Credits +------- + +Developed by [Omar Cornut](http://www.miracleworld.net). The library was developed with the support of [Media Molecule](http://www.mediamolecule.com) and first used internally on the game [Tearaway](http://tearaway.mediamolecule.com). + +Inspiration, feedback, and testing: Casey Muratori, Atman Binstock, Mikko Mononen, Emmanuel Briney, Stefan Kamoda, Matt Willis. Thanks! + +License +------- + +ImGui is licensed under the MIT License, see LICENSE for more information.