Merge pull request #1260 from jgrisham/patch-1

Modify macOS build files to only allow GUI launch on supported OS versions (and associated documentation change)

README.md

@@ -82,33 +82,67 @@ specific packages.
 
 [![Packaging status](https://repology.org/badge/vertical-allrepos/barrier.svg)](https://repology.org/project/barrier/versions)
 
-### FAQ
+## FAQ - Frequently Asked Questions
 
-Q: Does drag and drop work on linux?
+**Q: Does drag and drop work on linux?**
 
-A: No
+> A: No *(see [#855](https://github.com/debauchee/barrier/issues/544) if you'd like to change that)*
 
-Q: What OSes are supported?
 
-A:
+**Q: What OSes are supported?**
-  - Windows 7, 8, 8.1, and 10
-  - MacOS/OS X
-  - Linux
-  - FreeBSD
-  - OpenBSD
 
-Q: Are 32-bit versions of Windows supported?
+> A: The [most recent release](https://github.com/debauchee/barrier/releases/latest) of Barrier is known to work on:
+>  - Windows 7, 8, 8.1, 10, and 11
+>  - macOS *(previously known as OS X or Mac OS X)*  
+>    - _The current GUI does **not** work on OS versions prior to macOS 10.12 Sierra (but see the related answer below)_
+>  - Linux
+>  - FreeBSD
+>  - OpenBSD
 
-A: No
 
-Q: How do I load my configuration on startup?
+**Q: Are 32-bit versions of Windows supported?**
 
-A: Start the binary with the argument `--config <path_to_saved_configuration>`
+> A: No
 
-Q: After loading my configuration on the client the field 'Server IP' is still empty!
 
-A: Edit your configuration to include the server's ip address manually with
+__Q: Is it possible to use Barrier on Mac OS X / OS X versions prior to 10.12?__
 
-    (...)
+> A: Not officially.
-    section: options
+>   - For OS X 10.10 Yosemite and later:
-        serverhostname=<AAA.BBB.CCC.DDD>
+>     - [Barrier v2.1.0](https://github.com/debauchee/barrier/releases/tag/v2.1.0) or earlier _may_ work.
+>   - For Mac OS X 10.9 Mavericks _(and perhaps earlier)_:
+>     1. the command-line portions of the [current release](https://github.com/debauchee/barrier/releases/latest) _should_ run fine.
+>     2. The GUI will _not_ run, as that OS version does not include Apple's *Metal* framework.
+>         - _(For a GUI workaround for Mac OS X 10.9, see the [discussion at issue #544](https://github.com/debauchee/barrier/issues/544))_
+
+> Note: Only versions [v2.3.4](https://github.com/debauchee/barrier/releases/tag/v2.3.4) and [later](https://github.com/debauchee/barrier/releases/latest) of Barrier can be supported by this project.
+>  - Anyone using an earlier version is advised to upgrade due to recently-addressed security vulnerabilities *(and other bug fixes)*. 
+>    - This is especially important for computers accessible from the public Internet *(or from other shared/untrusted networks, such as when using shared WiFi)*.
+
+
+**Q: How do I load my configuration on startup?**
+
+> A: Start the binary with the argument `--config <path_to_saved_configuration>`
+
+
+**Q: After loading my configuration on the client the field 'Server IP' is still empty!**
+
+> A: Edit your configuration to include the server's ip address manually with
+> 
+>```
+>(...)
+>
+>section: options
+>    serverhostname=<AAA.BBB.CCC.DDD>
+>```
+
+**Q: Are there any other significant limitations with the current version of Barrier?**
+
+> A: Currently:
+>    - Barrier currently has limited UTF-8 support; issues have been reported with processing various languages.
+>      - *(see [#860](https://github.com/debauchee/barrier/issues/860))*
+>    - There is interest in future support for the Wayland compositor/display server protocol *([official site](https://wayland.freedesktop.org/) | [Wikipedia article](https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)))* on Linux.
+>      - As of late 2021, there is no expected completion date for *Wayland* support.
+>      - *(see [#109](https://github.com/debauchee/barrier/issues/109) and [#1251](https://github.com/debauchee/barrier/issues/1251) for status or to volunteer your talents)*
+>
+> The complete list of open issues can be found in the ['Issues' tab on GitHub](https://github.com/debauchee/barrier/issues?q=is%3Aissue+is%3Aopen). Help is always appreciated.

dist/macos/bundle/Barrier.app/Contents/Info.plist.in

@@ -31,6 +31,6 @@
     <key>NSHumanReadableCopyright</key>
     <string>© 2018 Debauchee Open Source Group</string>
     <key>LSMinimumSystemVersion</key>
-    <string>10.9.0</string>
+    <string>10.12.0</string>
   </dict>
 </plist>

doc/newsfragments/1260_macos-launchinfo.bugfix:

@@ -0,0 +1 @@
+Corrected macOS packaging to provide a better error message when a user attempts to launch Barrier on an incompatible macOS version. (https://github.com/debauchee/barrier/issues/1260).

doc/newsfragments/1260_update-faqs.doc

@@ -0,0 +1 @@
+Updated FAQs in project README.md with more detail on OS support and links to issues for infrequent users. (https://github.com/debauchee/barrier/issues/1260).