File: README.md
winit - Cross-platform window creation and management in Rust
[dependencies]
winit = "0.31.0-beta.3"[Documentation](https://docs.rs/winit)
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
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.
CONTRIBUTING
For contributing guidelines see CONTRIBUTING.md.
MSRV Policy
This crate's Minimum Supported Rust Version (MSRV) is 1.86. 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, andstable is the latest stable version of Rust. This bound may be broken in case of a major ecosystem shift or a security vulnerability.
An exception is made 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.
Redox OS is also not covered by this MSRV policy, as it requires a Rust nightly
toolchain to compile.
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.
Repository License
Note that the license in LICENSE doesn't apply in full to the DPI package ./dpi.
Full details can be found in that folder's README.
File: dpi/README.md
DPI
Full docs can be found on docs.rs.
License
Most of DPI is licensed under the Apache License, Version 2.0 (LICENSE).
All files except for src/libm.rs (and LICENSE-LIBM-MIT) are available solely under that license.
For its no_std support, DPI uses code from the libm crate.
This is in the libm.rs file, and is licensed solely under the MIT Licence (LICENSE-LIBM-MIT).
That file contains details of all potentially applicable copyright notices.
This is feature gated to only be included if you disable the std feature, otherwise it will not be compiled into your final binary
(and so these license terms will not apply).
Overall, this means that the license for this crate depends on what features you have enabled.
If you enable the std feature, then DPI uses only code available under the Apache-2.0 license, and so can be used under the terms of that license.
However, if you disable the std feature, then both these licenses must be followed to use the crate as a whole.