4ade1a7518
As previously discussed in today's meeting, this commit adds a code of conduct to winit. I've elected to re-use the Rust project's Code of Conduct, as it is also in use by other popular Rust projects and I agree with its intentions. The goal is to set forward a set of explicit expectations for how discourse in the rust-windowing project should be conducted. I've deliberately left out a mechanism for enforcing this code of conduct. My hope is that, by the act of setting these expectations, contributors will voluntarily follow them. In addition I have no interest in being an internet janitor. If this becomes necessary in the future we can look into it later. rust-windowing collaborators, please read the linked Code of Conduct. Not only for expectations of behavior, but also for expectations of how it will be enforced should it come to it. Signed-off-by: John Nunley <dev@notgull.net> |
||
|---|---|---|
| .cargo | ||
| .github | ||
| docs/res | ||
| dpi | ||
| examples | ||
| run-wasm | ||
| src | ||
| tests | ||
| .gitattributes | ||
| .gitignore | ||
| build.rs | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| clippy.toml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| deny.toml | ||
| FEATURES.md | ||
| HALL_OF_CHAMPIONS.md | ||
| LICENSE | ||
| README.md | ||
| rustfmt.toml | ||
winit - Cross-platform window creation and management in Rust
[dependencies]
winit = "0.29.14"
Documentation
For features within the scope of winit, see FEATURES.md.
For features outside the scope of winit, see Are we GUI Yet? and Are we game yet?, depending on what kind of project you're looking to do.
Contact Us
Join us in our 
room. If you don't get an answer there, try 
.
The maintainers have a meeting every friday at UTC 15. The meeting notes can be found here.
Usage
Winit is a window creation and management library. It can create windows and lets you handle events (for example: the window being resized, a key being pressed, a mouse movement, etc.) produced by the window.
Winit is designed to be a low-level brick in a hierarchy of libraries. Consequently, in order to show something on the window you need to use the platform-specific getters provided by winit, or another library.
MSRV Policy
This crate's Minimum Supported Rust Version (MSRV) is 1.70. Changes to the MSRV will be accompanied by a minor version bump.
As a tentative policy, the upper bound of the MSRV is given by the following formula:
min(sid, stable - 3)
Where sid is the current version of rustc provided by Debian Sid, and
stable is the latest stable version of Rust. This bound may be broken in case of a major ecosystem shift or a security vulnerability.
The exception is for the Android platform, where a higher Rust version must be used for certain Android features. In this case, the MSRV will be capped at the latest stable version of Rust minus three. This inconsistency is not reflected in Cargo metadata, as it is not powerful enough to expose this restriction.
All crates in the rust-windowing organizations have the
same MSRV policy.
Platform-specific usage
Check out the winit::platform module for platform-specific usage.