Skip to content

Commit

Permalink
Note on building against a non-tagged imgui release
Browse files Browse the repository at this point in the history
  • Loading branch information
dbr committed Mar 3, 2021
1 parent 89e94c5 commit 90c2178
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions imgui-sys/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 90c2178

Please sign in to comment.