Getting started

Dependencies

KAS requires a recent Rust compiler (check the rust-version).

Using nightly rust with the nightly (or nightly-diagnostics) feature allows emitting warnings from macros. It is recommended to this when developing custom widgets.

Linux libraries

You don't need to install anything, unless you want to write GLSL shaders or use HarfBuzz. But, in case you do:

# For Ubuntu:
sudo apt-get install build-essential git libxcb-shape0-dev libxcb-xfixes0-dev libharfbuzz-dev

# For Fedora:
sudo dnf install libxcb-devel harfbuzz-devel glslc

Running examples

Clone the repository and run the examples as follows:

git clone https://github.com/kas-gui/kas.git
cd kas
cargo run --example gallery
cd examples/mandlebrot; cargo run

Buliding documentation locally

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --features=stable --workspace --no-deps --open

Faster builds

See Build-configuration#faster-builds.