Turtle Dove 2cf50a523a docs: Add README.md and CONTRIBUTING.md for fork
- README.md: Fork overview, sync status, active contribution branches,
  quick start, upstream resources, license/credits
- CONTRIBUTING.md: Guidelines for reporting issues, submitting PRs,
  syncing with upstream, branch strategy, areas needing help
2026-07-13 08:13:45 -05:00
2026-01-03 01:07:58 +01:00

imgui_xl

Dear ImGui XL — An enhanced community fork of Dear ImGui, focused on backend improvements, CI/CD fixes, and extended examples.

License: MIT Upstream Branch: master

Dear ImGui is a bloat-free graphical user interface library for C++. It outputs optimized vertex buffers that you can render anytime in your 3D-pipeline-enabled application. It is fast, portable, renderer-agnostic, and self-contained (no external dependencies).

Why This Fork?

This fork (imgui_xl) serves as a staging ground for community contributions to Dear ImGui. It tracks upstream master and docking branches closely and adds:

  • Backend fixes — Vulkan use-after-free fix for multi-viewport dynamic rendering (#9390)
  • CI/CD improvements — Android build fixed via pinned Gradle wrapper (#8878)
  • Enhanced metadata — Topics, issues, and discussions enabled for community engagement
  • Contributing guide — Clear path for new contributors

Sync Status

This fork is kept in sync with ocornut/imgui:

Branch Tracks Status
master upstream/master ✅ Synced
docking upstream/docking ✅ Synced

Active Contribution Branches

Branch Issue Description
fix/vulkan-dynamic-rendering-use-after-free #9390 Fix use-after-free in Vulkan multi-viewport dynamic rendering
fix/android-ci-gradle-wrapper #8878 Pin Gradle 9.4.1 via wrapper for AGP 9.2.0 compatibility

Quick Start

# Clone
git clone https://github.com/Turtle-PB/imgui_xl.git
cd imgui_xl

# Build example_null (no backend dependencies needed)
# Windows (MinGW)
mingw32-make -C examples/example_null

# Windows (MSVC)
cd examples\example_null
.\build_win32.bat

# Linux/macOS
cd examples/example_null
make

Contributing

See CONTRIBUTING.md for guidelines on submitting issues, PRs, and syncing with upstream.

Upstream Resources

License

MIT License — see LICENSE.txt for details.

Credits

Dear ImGui is developed by Omar Cornut and every direct or indirect contributor to the GitHub repository.

Description
Dear ImGui: Bloat-free Graphical User interface for C++ with minimal dependencies
Readme 1.1 GiB
Languages
C++ 73.3%
C 24.1%
Objective-C++ 2.2%
Objective-C 0.2%
Python 0.1%