dnrops
/
xilem
mirror of https://github.com/linebender/xilem
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

`masonry_core`: Provide a better README. (#1157) 

Also, update it via `cargo rdme` and add corresponding CI.
This commit is contained in:
Bruce Mitchener 2025-07-18 23:53:50 +07:00 committed by GitHub
parent 54d73aaccb
commit 3dbb6edc8b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 59 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/ci.yml vendored
View File

@ -108,6 +108,9 @@ jobs:
- name: Run cargo rdme (masonry)
run: cargo rdme --check --heading-base-level=0 --workspace-project=masonry
- name: Run cargo rdme (masonry_core)
run: cargo rdme --check --heading-base-level=0 --workspace-project=masonry_core
- name: Run cargo rdme (masonry_winit)
run: cargo rdme --check --heading-base-level=0 --workspace-project=masonry_winit

56
masonry_core/README.md
View File

@ -1,3 +1,57 @@
# masonry_core
<div align="center">
# Masonry Core
**Traits and types of the Masonry toolkit**
[![Latest published version.](https://img.shields.io/crates/v/masonry_core.svg)](https://crates.io/crates/masonry_core)
[![Documentation build status.](https://img.shields.io/docsrs/masonry_core.svg)](https://docs.rs/masonry_core)
[![Apache 2.0 license.](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](#license)
\
[![Linebender Zulip chat.](https://img.shields.io/badge/Linebender-%23masonry-blue?logo=Zulip)](https://xi.zulipchat.com/#narrow/channel/317477-masonry)
[![GitHub Actions CI status.](https://img.shields.io/github/actions/workflow/status/linebender/xilem/ci.yml?logo=github&label=CI)](https://github.com/linebender/xilem/actions)
[![Dependency staleness status.](https://deps.rs/crate/masonry_core/latest/status.svg)](https://deps.rs/crate/masonry_core)
</div>
<!-- We use cargo-rdme to update the README with the contents of lib.rs.
To edit the following section, update it in lib.rs, then run:
cargo rdme --workspace-project=masonry_core --heading-base-level=0
Full documentation at https://github.com/orium/cargo-rdme -->
<!-- Intra-doc links used in lib.rs should be evaluated here.
See https://linebender.org/blog/doc-include/ for related discussion. -->
<!-- cargo-rdme start -->
Traits and types of the Masonry toolkit.
See [Masonry's documentation] for more details, examples and resources.
[Masonry's documentation]: https://docs.rs/masonry/latest/
<!-- cargo-rdme end -->
## Minimum supported Rust Version (MSRV)
This version of Masonry Core has been verified to compile with **Rust 1.88** and later.
Future versions of Masonry Core 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.
## Community
Discussion of Masonry Core development happens in the [Linebender Zulip](https://xi.zulipchat.com/), specifically the [#masonry channel](https://xi.zulipchat.com/#narrow/channel/317477-masonry).
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>)
[Rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct
<!-- Needs to be defined here for rustdoc's benefit -->
[LICENSE]: LICENSE

2
masonry_core/src/lib.rs
View File

@ -4,7 +4,7 @@
//! Traits and types of the Masonry toolkit.
//! See [Masonry's documentation] for more details, examples and resources.
//!
//! [Masonry's documentation]: https://docs.rs/masonry_winit/latest/
//! [Masonry's documentation]: https://docs.rs/masonry/latest/
// LINEBENDER LINT SET - lib.rs - v3
// See https://linebender.org/wiki/canonical-lints/