Skip to content

Commit

Permalink
Move version requirements to crate-level docs
Browse files Browse the repository at this point in the history
  • Loading branch information
madsmtm committed Feb 23, 2024
1 parent a014641 commit 75854b5
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 6 deletions.
8 changes: 2 additions & 6 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Winit aims to expose an interface that abstracts over window creation and input handling and can
be used to create both games and applications. It supports the following main graphical platforms:
- Desktop
- Windows 7+ (10+ is tested regularly)
- macOS 10.7+ (10.14+ is tested regularly)
- Windows
- macOS
- Unix
- via X11
- via Wayland
Expand All @@ -13,9 +13,6 @@ be used to create both games and applications. It supports the following main gr
- iOS
- Android
- Web
- Chrome
- Firefox
- Safari 13.1+

Most platforms expose capabilities that cannot be meaningfully transposed onto others. Winit does not
aim to support every single feature of every platform, but rather to abstract over the common features
Expand Down Expand Up @@ -151,7 +148,6 @@ If your PR makes notable changes to Winit's features, please update this section
* Setting the X11 parent window

### iOS
* `winit` has a minimum OS requirement of iOS 8
* Get the `UIScreen` object pointer
* Setting the `UIView` hidpi factor
* Valid orientations
Expand Down
3 changes: 3 additions & 0 deletions src/platform/ios.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
//! # iOS / UIKit
//!
//! Winit has an OS requirement of iOS 8 or higher, and is regularly tested on
//! iOS 9.3.
//!
//! iOS's main `UIApplicationMain` does some init work that's required by all
//! UI-related code (see issue [#1705]). It is best to create your windows
//! inside `Event::Resumed`.
Expand Down
3 changes: 3 additions & 0 deletions src/platform/macos.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
//! # macOS / AppKit
//!
//! Winit has an OS requirement of macOS 10.11 or higher (same as Rust
//! itself), and is regularly tested on macOS 10.14.
//!
//! A lot of functionality expects the application to be ready before you
//! start doing anything; this includes creating windows, fetching monitors,
//! drawing, and so on, see issues [#2238], [#2051] and [#2087].
Expand Down
3 changes: 3 additions & 0 deletions src/platform/web.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
//! # Web
//!
//! The officially supported browsers are Chrome, Firefox and Safari 13.1+,
//! though forks of these should work fine.
//!
//! Winit supports compiling to the `wasm32-unknown-unknown` target with
//! `web-sys`.
//!
Expand Down
3 changes: 3 additions & 0 deletions src/platform/windows.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
//! # Windows
//!
//! The supported OS version is Windows 7 or higher, though Windows 10 is
//! tested regularly.
use std::{ffi::c_void, path::Path};

use crate::{
Expand Down

0 comments on commit 75854b5

Please sign in to comment.