Navy.gif/imgui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Getting Started (markdown)

Marcus Ottosson 2016-04-21 06:30:58 +01:00
parent d25d3606fa
commit 326b021e0e
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Getting-Started.md

@ -21,17 +21,25 @@ This article will guide you through getting up and running with as many assumpti
### Organisation ### Organisation
```
| File | Description | File | Description
|:-------------------|:------------------- |--------------------|--------------------
| `examples/` | Some examples for various backends and windowing libraries | imgui/ |
| `extra_fonts/` | Optional assets (that should really be contained in its own repository :) | examples/ | Some examples for various backends and windowing libraries
| `imconfig.h` | Template for *mandatory* configuration file (should really be optional :) | extra_fonts/ | Optional assets*
| `imgui.cpp` | The main source | imconfig.h | Template for mandatory configuration file**
| `imgui.h` | The main header | imgui.cpp |
| `imgui_demo.cpp` | An example (that should really be located in in `examples/` :) | imgui.h |
| `imgui_draw.cpp` | A mandatory source file (that should really be merged with `imgui.cpp` :) | imgui_demo.cpp | An example***
| `imgui_internal.h` | Internal details, without guarantee of backward compatibility | imgui_draw.cpp | A mandatory source file****
| `stb_*` | External library | imgui_internal.h | Internal details, without guarantee of backward compatibility
| stb_* | External library
* That should really be contained in its own repository :)
** That should really be optional :)
*** That should really be located in in `examples/` :)
**** That should really be merged with `imgui.cpp` :)
```
<br> <br>
<br> <br>