xilem/masonry
Bruce Mitchener e6e980de80
Improve `masonry` docs (#1059)
This fixes some things that have bitrotted due to API and other changes.

It also removes usages of `masonry_winit` where `masonry` should be used
instead.

Dependencies like `kurbo`, `peniko`, `smallvec`, and `vello` should be
referenced via their re-exports so that code outside of Masonry doesn't
have to keep track of the versions and maintain their own dependencies.
2025-06-10 03:14:23 +00:00
..
resources Rename `masonry_core` directory to `masonry`. (#968) 2025-05-09 11:43:01 +00:00
screenshots Rename `masonry_core` directory to `masonry`. (#968) 2025-05-09 11:43:01 +00:00
src Improve `masonry` docs (#1059) 2025-06-10 03:14:23 +00:00
.gitignore Rename `masonry_core` directory to `masonry`. (#968) 2025-05-09 11:43:01 +00:00
ARCHITECTURE.md Rewrite marker comments across multiple lines. (#1010) 2025-06-03 09:49:55 +00:00
Cargo.toml Split off core masonry modules into masonry_core crate (#1044) 2025-06-08 09:45:40 +00:00
LICENSE Remove appendix from `LICENSE` files. (#970) 2025-05-09 18:53:13 +00:00
README.md Update `README.md` structures to the latest Linebender standard. (#971) 2025-05-10 15:00:31 +00:00

README.md

Masonry

A foundational framework for Rust GUI libraries

Latest published version. Documentation build status. Apache 2.0 license.
Linebender Zulip chat. GitHub Actions CI status. Dependency staleness status.

Traits and types of the Masonry toolkit. See Masonry Winit's documentation for more details, examples and resources.

Minimum supported Rust Version (MSRV)

This version of Masonry has been verified to compile with Rust 1.86 and later.

Future versions of Masonry might increase the Rust version requirement. It will not be treated as a breaking change and as such can even happen with small patch releases.

Click here if compiling fails.

As time has passed, some of Masonry's dependencies could have released versions with a higher Rust requirement. If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.

# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1

Community

Discussion of Masonry development happens in the Linebender Zulip, specifically the #masonry channel. All public content can be read without logging in.

Contributions are welcome by pull request. The Rust code of conduct applies.

License

Licensed under the Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)