Merge remote-tracking branch 'refs/remotes/origin/main'

Author: waydabber

README.md

@@ -36,28 +36,25 @@
 
 ## About
 
-M1 macs tend to have issues with custom resolutions. Notoriously they don't allow sub-4K resolution displays to have HiDPI ("Retina") resolutions even though (for example) a 24" QHD 1440p display would greatly benefit from having an 1920x1080 HiDPI "Retina" mode.
+Some Macs tend to have issues with custom resolutions. The new Apple Silicon Macs notoriously don't allow sub-4K resolution displays to have HiDPI ("Retina") resolutions even though most 1440p display would greatly benefit from having a HiDPI "Retina" mode. On other Macs the resolution options for wide displays are too constrained. To fix these issues, some resort to buying a 4K HDMI dummy dongle to fool macOS into thinking that a 4K display is connected and then mirror the contents of this dummy display to their actual monitor in order to have HiDPI resolutions available. Others use the built in screens of their MacBooks as a mirror source. These approaches have obvious drawbacks and limits.
 
-To fix this issue, some resort to buying a 4K HDMI dummy dongle to fool macOS into thinking that a 4K display is connected and then mirror the contents of this dummy display to their actual monitor in order to have HiDPI resolutions available. Others use the built in screens of their MacBooks to mirror to the external display. These approaches have obvious drawbacks and cannot solve all problems.
-
-To fix this problem, BetterDummy creates a virtual dummy display which you can then utilize as a mirror main.
+BetterDummy solves the problem by creating a flexible virtual "dummy" display that supports an unprecedented range of Retina resolutions. You can then utilize this dummy display as a mirror source for your display achieving any HiDPI resolution.
 
 Advantages of BetterDummy over a physical 4K HDMI dummy plug or mirroring your internal display:
 
-- Your HDMI port will remain usable for an other display on the Mac Mini.
+- Your HDMI port will remain usable for an other display on the Mac Mini
 - Your internal screen will be available as an extended space on a MacBook (or you can use clamshell mode).
 - Does not suffer from issues that prevalent with the physical dummy (like jittery mouse cursor).
-- Offers a much wider variety of HiDPI and standard resolutions.
+- Offers a much wider range of HiDPI and standard resolutions.
 - Works with all aspect ratios, does not depend on what resoluations are recorded in the dummy's EDID/firmware.
-- Does not utilize graphics hardware in vain so it is somewhat faster.
 - Available instantly.
 
-Some other possible uses:
+Some other  uses:
 
-- The app is also useful for anybody who is not satisfied with the offered default HiDPI resolutions offered by macOS - as in some cases this could be rather limiting - especially on Wide or UltraWide displays.
-- Use headless Macs (servers) with any resolution and HiDPI mode for remote access (tested on Intel Mac with Intel UHD 630 - please note that the app runs in user space after login).
+- The app is  useful for anybody who is not satisfied with the offered default HiDPI resolutions offered by macOS.
+- Use headless Macs (servers) with any resolution and HiDPI mode for remote access.
 - Scale Sidecar resolutions.
-- Better quality zooming (`System Preferences`»`Accessibility`»`Zoom`) or High Quality screenshots even on Full HD displays.
+- Better quality zooming (`System Preferences`»`Accessibility`»`Zoom`) or High Quality screenshots even on 1080p displays.
 - You can use it instead of or alongside other apps that create custom native resolutions.
 
 ## Usage
@@ -73,8 +70,7 @@ Some other possible uses:
 3. In `System Preferences` -> `Displays` you'll see the new Dummy display (for example `Dummy 16:9`)
 4. Activate mirroring. The `Main` display should be the Dummy display
 5. Set the Dummy display as `Optimize for`
-6. Set `Resolution` as `Scaled` - **you should hold the `Option` key while clicking on the `Scaled` option for a fuller list of resolutions!**
-7. You can also click `Show all resolutions` for even more resolutions
+6. Set the `Resolution` as `Scaled` (you should hold the `Option` key while clicking on the `Scaled` option for a full list of resolutions!) or use the app's own resolution selector located in the app menu.
 
 <div align="center">
 <img src=".github/displayprefs.png" width="550"/>
@@ -88,12 +84,10 @@ For more information on usage, see the [the additional help section](#additional
 
 Notes:
 
-- Instead of using the `System Preferences` -> `Displays` to change the resolution, you can use the in-app menu for this as well (`Manage Dummies` -> `Set resolution`) as of v1.0.10
-- The tutorial was compiled on an Apple Silicon Mac running macOS Monterey (the app works on Intel and Big Sur as well - steps are slightly differnt, see [this article](https://macfinder.co.uk/blog/how-to-mirror-specific-displays-in-os-x-mirror-some-but-not-all-of-your-monitors-on-an-apple-system/) on how to customize mirroring on Big Sur).
+- The tutorial was compiled on macOS Monterey (for Big Sur as well - steps are slightly different, see [this article](https://macfinder.co.uk/blog/how-to-mirror-specific-displays-in-os-x-mirror-some-but-not-all-of-your-monitors-on-an-apple-system/) on how to customize mirroring on Big Sur).
 - For most configurations, you'll see HiDPI 'Retina' resolutions in the list by default and see and additional non-HiDPI resolutions marked with a `(low resolution)` tag in the resolution list if `Show all resolutions` is toggled. On some configurations however, you might see HiDPI (high resolution) display modes marked with a `(HiDPI)` tag and standard resolutions _without a tag_.
 - You might have to fight a bit with macOS Monterey's new `Displays` tab in Preferences as the `Optimize for` setting tends to reset at random times to the physical display for unknown reasons during changing settings. If this happens, you can set it back to the Dummy.
 - You may want to enable the `System Preferences`»`Notifications & Focus`»`Allow Notifications`»`When mirroring or sharing the display` option to allow notifications when mirroring is turned on.
-- Please note that the app cannot increase the number of pixels on your display and is unable to make a 1080p display look like a 4K display (the only benefit for a 1080p display is better clarity in zooming or the ability to make high resolution screenshots).
 
 ## Installation
 
@@ -104,14 +98,64 @@ Notes:
 
 ## Supporting the project
 
-I am thankful for each of you who [contributed to the project](https://opencollective.com/betterdummy). Every little bit helps. If you find use in the app and did not contribute so far, please consider a donation. Thank you!
+I am thankful for each of you who [contributed to the project](https://opencollective.com/betterdummy). Every little bit helps! If you find use in the app and did not contribute so far, please consider a donation so I can continue working on this app. :) Thank you!
+
+Financial contributors (as of 20/11/2021, list is updated periodically):
+
+<table align="center">
+<tr>
+<td valign="top" width="200">
+Alessio N.<br/>
+Angus<br/>
+Arthur Müller<br/>
+Chetan Kunte<br/>
+Clark Jacobsohn<br/>
+David Richardson<br/>
+David W<br/>
+Dinko Belchevski<br/>
+Florian Gross<br/>
+Gavin Liu<br/>
+Igor Yugay<br/>
+Incognito<br/>
+Jari Hanhela<br/>
+</td>
+<td valign="top" width="200">
+Jeff Lopes<br/>
+Jérôme Seydoux<br/>
+JIANG Y<br/>
+Julian Pawlowski<br/>
+Justin Vanderhooft<br/>
+kim<br/>
+Lorne Rutherford<br/>
+Marco<br/>
+Martin Clayton<br/>
+Maurice Schleußinger<br/>
+Michael Charo<br/>
+Nick Lappas<br/>
+Nikola Milojević<br/>
+</td>
+<td valign="top" width="200">
+Reactual<br/>
+Rick<br/>
+Stephen Richardson<br/>
+Sven Blum<br/>
+Tom Dai<br/>
+vividfog<br/>
+William Edney<br/>
+Wolf1701<br/>
+Yurong You<br/>
+<i>+ 3 anonymous</i><br/><br/>
+<a href="https://opencollective.com/betterdummy/donate">Join the list</a>
+</td>
+</tr>
+</table>
 
 Please don't forget to star the GitHub page and spread the word about the app. :)
 
 ## Compatibility
 
 - The app should be compatible with all M1 class machines running macOS Monterey (MacBook Air, Mini, 2020 and 2021 MacBook Pros).
-- The app is also compatible with Intel and macOS Big Sur (testing was limited to a single Intel Mac with Intel UHD 630 running Big Sur).
+- The app is also compatible with more recent Intel Macs and macOS Big Sur (testing was limited to a single Intel Mac with Intel UHD 630 running Big Sur).
 - The app is compatible with headless mode as well (this was tested on Intel).
 
 ## Additional help
@@ -154,21 +198,19 @@ There are some issues which are related to limitations/issues in macOS itself:
 - Only SDR content is supported.
 - Mirroring any content to the internal display of the 2021 MacBook Pros will force the mirror under the notch.
 - Due to a bug present in the current macOS versions, mirroring virtual displays (Sidecar, BetterDummy, etc) might cause sleep issues on some configurations. The app has some workarounds for this issue but these might not work on all configurations.
-- Due to a bug present in the current macOS versions, swiping or keyboard shortcuts to switch spaces do not work on extended (secondary) mirror sets that involve virtual displays.
+- Due to a bug present in the current macOS versions, swiping or keyboard shortcuts to switch spaces do not work on extended (secondary) mirror sets.
 - Apple's TV app will not show any protected content on non-native hardware accellerated displays (this applies to Sidecar, DisplayLink and any other tech that relies on virtual displays as well).
 
-Some of these issues affect physical dummy mirrors as well.
-
 ## Don't forget to check out
 
-**If you like this app, you'll like [MonitorControl](https://monitorcontrol.app) as well!** Control the brightness, volume of your external display like a native Apple display!
+**If you like BetterDummy, you'll like [MonitorControl](https://monitorcontrol.app) as well!** Control the brightness, volume of your external display like a native Apple display! The two apps are fully optimized to work togeteher.
 
-## Discord channel
+## Thanks
 
-You can join the (mostly self help) discussion on the new [BetterDummy discord channel](https://discord.gg/aKe5yCWXSp).
+- [@tml1024](https://github.com/tml1024)! - for FluffyDisplay as a starting point for this project
+- [@w0lfschild](https://github.com/w0lfschild) - for maintaining reverse engineered macOS headers
+- [@JoniVR](https://github.com/JoniVR) and [@the0neyouseek](https://github.com/the0neyouseek) - from MonitorControl
 
-## Thanks
+## Discord channel
 
-- [@tml1024](https://github.com/tml1024)! - FluffyDisplay + reused adapted CGVirtualDisplay headers reverse engineered by [@w0lfschild](https://github.com/w0lfschild)
-- [@JoniVR](https://github.com/JoniVR) - MonitorControl + sparkle scripts
-- [@the0neyouseek](https://github.com/the0neyouseek) - MonitorControl + sparkle scripts
+You can join the (mostly self help) discussion on the new [BetterDummy discord channel](https://discord.gg/aKe5yCWXSp).