Examples: update readme

This commit is contained in:
ocornut 2015-08-25 22:14:31 +01:00
parent 8cf7df7ec4
commit 62671ef96e

View File

@ -1,10 +1,10 @@
Those are standalone ready-to-build applications to demonstrate ImGui. Those are standalone ready-to-build applications to demonstrate ImGui.
Binaries of those demos are available from the main GitHub page. Binaries of some of those demos are available at http://www.miracleworld.net/imgui/binaries
TL;DR; TL;DR;
Refer to 'opengl_example' (not 'opengl3_example') to understand how the library is setup. Refer to 'opengl_example' (not 'opengl3_example') to understand how the library is setup.
Copy the imgui_impl_xxx.cpp/.h file you need if you are using one of the rendering backend used in an example. Copy the imgui_impl_xxx.cpp/.h files you need if you are using one of provided rendering/IO backends.
If you are using a different or your own backend, copy opengl_example/imgui_impl_opengl.cpp/.h to get started. If using different or your own backend, copy opengl_example/imgui_impl_opengl.cpp/.h to get started.
ImGui is highly portable and only requires a few things to run: ImGui is highly portable and only requires a few things to run:
@ -29,8 +29,9 @@ opengl_example/
opengl3_example/ opengl3_example/
OpenGL example, using GLFW/GL3W + programmable pipeline. OpenGL example, using GLFW/GL3W + programmable pipeline.
This uses more modern OpenGL calls and custom shaders. This uses more modern OpenGL calls and custom shaders.
Even if your application is using modern OpenGL you are better off copying the code from the fixed pipeline version! Even if your application is using modern OpenGL you are better off copying the code from the fixed
I don't think there is an advantage using this over the simpler example, but it is provided for reference. pipeline version! I don't think there is an advantage using this over the simpler example, but it is
provided for reference.
directx9_example/ directx9_example/
DirectX9 example, Windows only. DirectX9 example, Windows only.
@ -41,7 +42,8 @@ directx11_example/
ios_example/ ios_example/
iOS example. iOS example.
Using Synergy to access keyboard/mouse data from server computer. Synergy keyboard integration is rather hacky. Using Synergy to access keyboard/mouse data from server computer.
Synergy keyboard integration is rather hacky.
sdl_opengl_example/ sdl_opengl_example/
SDL2 + OpenGL example. SDL2 + OpenGL example.