From 91082f07fbea06135a2a135894b4be04644dd74d Mon Sep 17 00:00:00 2001 From: Bill Hollings Date: Thu, 1 Mar 2018 19:42:15 -0500 Subject: [PATCH] Add build and runtime OS and device requirements to documentation. --- Docs/MoltenVK_Runtime_UserGuide.md | 19 ++++++++++++++++--- README.md | 20 ++++++++++++++------ 2 files changed, 30 insertions(+), 9 deletions(-) diff --git a/Docs/MoltenVK_Runtime_UserGuide.md b/Docs/MoltenVK_Runtime_UserGuide.md index 9f39e870..71f814b3 100755 --- a/Docs/MoltenVK_Runtime_UserGuide.md +++ b/Docs/MoltenVK_Runtime_UserGuide.md @@ -21,6 +21,7 @@ Table of Contents - [About **MoltenVK**](#about_moltenvk) - [Running the **MoltenVK** Demo Applications](#demos) - [Installing **MoltenVK** in Your *Vulkan* Application](#install) + - [Build and Runtime Requirements](#requirements) - [Install as Static Library Framework](#install_static_lib) - [Install as Dynamic Library](#install_dynamic_lib) - [Interacting with the **MoltenVK** Runtime](#interaction) @@ -95,9 +96,21 @@ features by modifying *Xcode* build settings. All of this is explained in the Installing **MoltenVK** in Your *Vulkan* Application ---------------------------------------------------- ->***Note:*** **MoltenVK** can be run on *iOS 9* and *macOS 11.0* devices, - but it does reference advanced OS frameworks during building. *Xcode 9* - or above is required to build and link **MoltenVK** projects. + +### Build and Runtime Requirements + +At development time, **MoltenVK** references advanced OS frameworks during building. + +- *Xcode 9* or above is required to build and link **MoltenVK** projects. + +Once built, **MoltenVK** can be run on *iOS* or *macOS* devices that support *Metal*. + +- **MoltenVK** requires at least *macOS 10.11* or *iOS 9*. +- Information on *macOS* devices that are compatible with *Metal* can be found in + [this article](http://www.idownloadblog.com/2015/06/22/how-to-find-mac-el-capitan-metal-compatible). +- Information on compatible *iOS* devices that are compatible with *Metal* can be found in + [this article](https://developer.apple.com/library/content/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/HardwareGPUInformation/HardwareGPUInformation.html). + ### Install as Static Library Framework diff --git a/README.md b/README.md index b9297ac0..df3cf4d8 100755 --- a/README.md +++ b/README.md @@ -120,9 +120,7 @@ The updated versions will then be "locked in" the next time the `MoltenVK` repos This procdure updates all of the Third-Party library submodules. To update only a single submodule, or for more information about the various Third-Party libraries and submodules used by **MoltenVK**, -please refer to the following documents: - -- [`Docs/ThirdPartyConfig.md`](Docs/ThirdPartyConfig.md) +please refer to the [`Docs/ThirdPartyConfig.md`](Docs/ThirdPartyConfig.md) document. @@ -134,9 +132,19 @@ Building **MoltenVK** instructions in the [*Third-Party Components*](#third-party) section above to retrieve and install the required third-party components. ->***Note:*** At runtime, **MoltenVK** can run on *iOS 9* and *macOS 10.11* devices, ->but it does reference advanced OS frameworks during building. *Xcode 9* ->or above is required to build **MoltenVK**, and build and link **MoltenVK** projects. +At development time, **MoltenVK** references advanced OS frameworks during building. + +- *Xcode 9* or above is required to build and link **MoltenVK** projects. + +Once built, **MoltenVK** can be run on *iOS* or *macOS* devices that support *Metal*. + +- **MoltenVK** requires at least *macOS 10.11* or *iOS 9*. +- Information on *macOS* devices that are compatible with *Metal* can be found in + [this article](http://www.idownloadblog.com/2015/06/22/how-to-find-mac-el-capitan-metal-compatible). +- Information on compatible *iOS* devices that are compatible with *Metal* can be found in + [this article](https://developer.apple.com/library/content/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/HardwareGPUInformation/HardwareGPUInformation.html). + + The `MoltenVKPackaging.xcodeproj` *Xcode* project contains targets and schemes to build and package the entire **MoltenVK** runtime distribution package, or to build individual