diff --git a/Cargo.toml b/Cargo.toml index bcf27f4..899379c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "implot" -version = "0.1.0" +version = "0.0.1" edition = "2018" authors = ["Sandro Merkli", "implot-rs contributors"] description = "High-level Rust bindings to implot" @@ -19,5 +19,5 @@ members = [ ] exclude = [ "implot-sys-bindgen", - "testexample", + "implot-examples", ] diff --git a/README.md b/README.md index 174402f..ba5e2b1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ # implot-rs -🚧 **Work in progress, check back later (or open an issue if you'd like to collaborate)** 🚧 +Rust bindings for [ImPlot](https://github.com/epezent/implot), built by running +[bindgen](https://github.com/rust-lang/rust-bindgen) on [cimplot](https://github.com/cimgui/cimplot). +![demo](demo.png) -Initial attempt at creating Rust bindings for https://github.com/epezent/implot. +## Requirements +imgui-rs requires minimum Rust version 1.40, so this project does as well by extension. +Currently the master branch of imgui-rs is used as a dependency until +https://github.com/Gekkio/imgui-rs/pull/339 makes it into a release. -At this point, raw bindings are working in implot-sys, and there is a test example -(just an adapted version of imgui-rs' example) that calls into them for trying things -out. More idiomatic bindings will be built next. +The sys crate compiles imgui, so a C++ compiler will also be required. + +## Status +Currently a work in progress. The author is open to collaboration, if you'd like to +help, feel free to reach out via a Github issue. + +At this point, raw bindings are working in implot-sys, and more idiomatic interfaces +for plot creation as well as adding lines to plots are implemented. Everything else +is still being built. diff --git a/demo.png b/demo.png new file mode 100644 index 0000000..0b3b73d Binary files /dev/null and b/demo.png differ diff --git a/testexample/Cargo.toml b/implot-examples/Cargo.toml similarity index 100% rename from testexample/Cargo.toml rename to implot-examples/Cargo.toml diff --git a/testexample/src/main.rs b/implot-examples/examples/hello_world.rs similarity index 100% rename from testexample/src/main.rs rename to implot-examples/examples/hello_world.rs diff --git a/testexample/src/support/clipboard.rs b/implot-examples/examples/support/clipboard.rs similarity index 100% rename from testexample/src/support/clipboard.rs rename to implot-examples/examples/support/clipboard.rs diff --git a/testexample/src/support/mod.rs b/implot-examples/examples/support/mod.rs similarity index 100% rename from testexample/src/support/mod.rs rename to implot-examples/examples/support/mod.rs