From 90c2178366f6ccd7f34fcdddc1c305b03d7e4309 Mon Sep 17 00:00:00 2001 From: dbr Date: Wed, 3 Mar 2021 17:02:13 +1100 Subject: [PATCH] Note on building against a non-tagged imgui release --- imgui-sys/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/imgui-sys/README.md b/imgui-sys/README.md index 7a12896..c4303c8 100644 --- a/imgui-sys/README.md +++ b/imgui-sys/README.md @@ -58,6 +58,22 @@ cargo run --example test_window_impl +### Building a specific revision + +cimgui has pre-generated bindings to specific versions of imgui - usually for each regular imgui release, and the WIP docking branch at the same time as the release. + +However this will not work if you need to either + +1. Build `imgui-rs` against a specific revision, or +2. Build `imgui-rs` against another branch or fork + +Luckily running the generator is quite straight forward: + +1. Ensure `luajit` is installed (required by cimgui's generator) +2. In the `cimgui` submodule, check out the master branch +3. Update the nested `imgui` submodule (`imgui-sys/third-party/cimgui/imgui/`) to point to your desired upstream `imgui` +4. Run the generator as per https://github.com/cimgui/cimgui#using-generator +5. Run `cargo xtask bindgen` and follow the rest of the steps as usual ## Common sources of problems