# wlroots-rs
[](https://crates.io/crates/wlroots)
[](https://github.com/way-cooler/wlroots-rs/)
Safe Rust bindings for [wlroots](https://github.com/SirCmpwn/wlroots).
This library is currently tracking the wlroots version for its minor version. Patch versions are wlroots-rs specific.
# [Documentation](http://way-cooler.org/docs/wlroots/index.html)
# Building
To build wlroots-rs you have to init the wlroots submodule first and have all wlroots dependencies.
git submodule update --init
cargo build
If you want to compile against wlroots statically, add the `"static"` flag.
If you want use unstable wlroots features then add the `"unstable"` flag.
# Examples
See [the examples directory](https://github.com/swaywm/wlroots-rs/tree/master/examples) for basic examples using this library and at [Way Cooler the primary user of this library](https://github.com/way-cooler/way-cooler).
You can run an example using the following command:
```bash
cargo run --example <name of the example>
```