README.TXT 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. =====================================================================
  2. RmlUi Sample Applications
  3. =====================================================================
  4. This directory contains a collection of sample applications
  5. that demonstrate the use of RmlUi in small, easy
  6. to understand applications.
  7. To build the samples, you can either use Microsoft Visual Studio
  8. (using the project files found within each directory), or use SCons
  9. (SConstruct files are present in directories except those for
  10. Windows-specific samples).
  11. If you build with Visual Studio, make sure the actual sample is the
  12. 'startup project' (displayed in bold) rather than the sample shell
  13. project.
  14. If you build with SCons, be sure to compile the sample shell (found
  15. in /samples/shell/) before you compile other samples. All the
  16. SConstructs will build a debug build by default; to build a release
  17. version, run 'scons release'.
  18. Directory Overview:
  19. * assets - This directory contains the assets shared by
  20. all the sample applications.
  21. * basic - This directory contains basic applications
  22. that demonstrate initialisation, shutdown and
  23. installing custom interfaces.
  24. * customlog - setting up custom logging
  25. * directx10 - using DirectX 10 as a renderer
  26. * drag - dragging elements between containers
  27. * loaddocument - loading your first document
  28. * treeview - using a nested DataSource
  29. * invaders - A full implementation of the 1970s classic
  30. Space Invaders using the RmlUi interface.
  31. * luainvaders- Lua version of the invaders (only installed
  32. with the Lua plugin).
  33. * shell - Common platform specific code used by all the
  34. samples for open windows, processing input and
  35. access files.
  36. Supports Windows, MacOSX and Linux
  37. * tutorial - Tutorial code that should be used in conjunction
  38. with the tutorials on the RmlUi website.
  39. https://mikke89.github.io/RmlUiDoc/
  40. =====================================================================