README.md

chunkwm-rs

A Rust 'bridge' for creating chunkwm plugins.

Features

• Event handler.
• Easy API.
• CVar support.
• Subscriptions.
• Border methods (feature border, see Cargo features).
• Accessibility methods (feature accessibility, see Cargo features).

Usage

Add the following your Cargo.toml:

[dependencies]
chunkwm = { git = "https://github.com/splintah/chunkwm-rs" }

You then have to compile it as a cdylib, and use the plugin.cpp file from the Rust plugin template.

If you want to get the Makefile template and a small Rust library template, see the Rust plugin template.

Versioning

The versioning of this crate is as follows, with versions in the format of MAJOR.MINOR.PATH:

• The major version corresponds to the major version of chunkwm;
• the minor version corresponds to the minor version of chunkwm;
• the patch version is the patch version of this particular crate, and thus isn't based on chunkwm's versioning.

You should be able to specify the version in Cargo.toml (replacing "MARJOR.MINOR.PATCH" with the desired version, of course):

[dependencies]
chunkwm = { git = "https://github.com/splintah/chunkwm-rs", version = "MAJOR.MINOR.PATCH" }

Documentation

You can view the documentation at https://splintah.github.io/chunkwm-rs/master/chunkwm/. The documentation is automatically generated by Travis.

Cargo features

There are two features that toggle the compilation of the C/C++ library: border and accessibility:

• The border features gives you access to the chunkwm::common::border path.
• The accessibility features gives you access to the chunkwm::common::accessibility path, and enables some extra methods on Window and Application.

To use these features:

[dependencies]
chunkwm = { git = "https://github.com/splintah/chunkwm-rs", features = ["border", "accessibility"] }

You can, of course, only use the features you're interested in.