Starter project for portable app with optional GUI (GLFW/ImGui) and a rich builtin debug UI. Includes docked windows, log viewer, settings editor, configuration load/save, etc...
Key Features • Project Documentation • Getting Started • Contributing • Credits •
This is a starter project for ImGui
development in Modern C++ (>= c++-17) and with Modern CMake
(>= 3.14)
based on the asap template.
CMake
as the build system with or without presetsCMake
build helpers to facilitate declaration of library, exe, test modules,
for the end-to-end lifecycle including doc generation, test, packaging etc...ccache
compiler cachingCMake
package management with CPM
If you miss the old version of this starter project (you can't move to cxx-17 or you just can't bother), it is still in the old_cxx branch of this repo.
It is no longer updated though.
We have detailed guides for setting up an efficient development environment, the development process, project structure, etc. Take a look at the available guides here.
In addition to that, specific documentation for this project, its application modules, its usage and APIs, are provided in the project GitHub Pages site here.
It is strongly recommended that you take some time to browse the project documentation to familiarize yourself with its structure and development workflows.
Make sure you have a C++ compiler with C++-17 capabilities at least. Gnu, Clang and MSVC all can do that with a recent version.
git clone --recurse-submodules -j4 https://github.com/abdes/asap_app_imgui.git
mkdir _build && cd _build && cmake .. && cmake --build .
or just use one of the predefined CMake
presets. Detailed instructions are in
the project documentation, and many useful commands are listed
here.
You need to have a graphics system capable of providing OpenGL 3.2 to properly run the demo.
# Project options
option(BUILD_SHARED_LIBS "Build shared instead of static libraries." ON)
option(ASAP_BUILD_TESTS "Build tests." OFF)
option(ASAP_BUILD_EXAMPLES "Build examples." OFF)
option(ASAP_WITH_GOOGLE_ASAN "Instrument code with address sanitizer" OFF)
option(ASAP_WITH_GOOGLE_UBSAN "Instrument code with undefined behavior sanitizer" OFF)
option(ASAP_WITH_GOOGLE_TSAN "Instrument code with thread sanitizer" OFF)
option(ASAP_WITH_VALGRIND "Builds targets with valgrind profilers added" OFF)
If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
By contributing your code, you agree to license your contribution under the terms of the BSD-3-Clause or a more permissive license. All files are released with the BSD-3-Clause license.
Read the developer guides.
asap
In order to pull and merge updates from the upstream project, make sure to add it to the repo's remotes and disable pulling/merging tags from the upstream. We want tags to be limited to those made in this repo, not in the upstream.
git remote add upstream https://github.com/abdes/asap.git
git config remote.upstream.tagopt --no-tags