Browse Source

Examples: Added README into the Visual Studio solution to people are less likely to miss it.

ocornut 9 years ago
parent
commit
d673db3092

+ 8 - 6
examples/README.txt

@@ -2,15 +2,17 @@ Those are standalone ready-to-build applications to demonstrate ImGui.
 Binaries of some of those demos are available at http://www.miracleworld.net/imgui/binaries
 
 TL;DR; 
- Newcomers, read 'Programmer guide' imgui.cpp for notes on how to setup ImGui in your codebase.
- Refer to 'opengl_example' to understand how the library is setup, because it is the simplest one.
- Copy the imgui_impl_xxx.cpp/.h files you need if you are using one of provided rendering/IO backends.
- If using different or your own backend, copy opengl_example/imgui_impl_opengl.cpp/.h to get started.
- 
+ - Newcomers, read 'PROGRAMMER GUIDE' in imgui.cpp for notes on how to setup ImGui in your codebase.
+ - Refer to 'opengl_example' to understand how the library is setup, it is the simplest one.
+   The other examples requires more boilerplate and are harder to read.
+ - If you are using of the backend provided here, so you can copy the imgui_impl_xxx.cpp/h files
+   to your project and use them unmodified.
+ - If you have your own engine, you probably want to start from 'opengl_example' and adapt it to 
+   your engine, but you can read the other examples as well.
 
 ImGui is highly portable and only requires a few things to run:
  - Providing mouse/keyboard inputs
- - Load the font atlas texture into GPU memory
+ - Load the font atlas texture into graphics memory
  - Providing a render function to render indexed textured triangles
  - Optional: clipboard support, mouse cursor supports, Windows IME support, etc.
 So this is essentially what those examples are doing + the obligatory cruft for portability.

+ 3 - 0
examples/directx11_example/directx11_example.vcxproj

@@ -150,6 +150,9 @@
     <ClCompile Include="imgui_impl_dx11.cpp" />
     <ClCompile Include="main.cpp" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

+ 3 - 0
examples/directx11_example/directx11_example.vcxproj.filters

@@ -39,4 +39,7 @@
       <Filter>imgui</Filter>
     </ClCompile>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
 </Project>

+ 3 - 0
examples/directx9_example/directx9_example.vcxproj

@@ -150,6 +150,9 @@
     <ClInclude Include="..\..\imgui_internal.h" />
     <ClInclude Include="imgui_impl_dx9.h" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

+ 3 - 0
examples/directx9_example/directx9_example.vcxproj.filters

@@ -40,4 +40,7 @@
       <Filter>imgui</Filter>
     </ClInclude>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
 </Project>

+ 3 - 0
examples/opengl3_example/opengl3_example.vcxproj

@@ -163,6 +163,9 @@
     <ClInclude Include="..\libs\gl3w\GL\glcorearb.h" />
     <ClInclude Include="imgui_impl_glfw_gl3.h" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

+ 3 - 0
examples/opengl3_example/opengl3_example.vcxproj.filters

@@ -52,4 +52,7 @@
       <Filter>imgui</Filter>
     </ClInclude>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
 </Project>

+ 3 - 0
examples/opengl_example/opengl_example.vcxproj

@@ -160,6 +160,9 @@
     <ClInclude Include="..\..\imgui_internal.h" />
     <ClInclude Include="imgui_impl_glfw.h" />
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

+ 3 - 0
examples/opengl_example/opengl_example.vcxproj.filters

@@ -40,4 +40,7 @@
       <Filter>imgui</Filter>
     </ClInclude>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="..\README.txt" />
+  </ItemGroup>
 </Project>