Document new macos env var in README

rust-windowing · Feb 3, 2021 · c4378b8 · c4378b8
1 parent ec02393
commit c4378b8
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -110,3 +110,13 @@ fn main() {
 ```
 
 And run the application with `cargo apk run --example request_redraw_threaded`
+
+#### MacOS
+
+To ensure compatibility with older MacOS systems, winit links to
+`CGDisplayCreateUUIDFromDisplayID` through the `CoreGraphics` framework. However
+, under certain setups this function is only available to be linked through
+the newer `ColorSync` framework. So, winit provides the `WINIT_LINK_COLORSYNC`
+environment variable which can be set to `1` or `true` to enable linking via
+`ColorSync`.
+