From 36e51e16b8fdf52066dffa4ee3a875b9f50436cc Mon Sep 17 00:00:00 2001
From: waydabber <37590873+waydabber@users.noreply.github.com>
Date: Wed, 2 Oct 2024 19:24:04 +0200
Subject: [PATCH] Update README.md
---
README.md | 39 +++++++++++++++++++++------------------
1 file changed, 21 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 569f74d..1068ada 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,15 @@ brew install MonitorControl
For additional features, more advanced brightness control with XDR/HDR brightness upscaling and support for more Mac models and displays, check out [BetterDisplay](https://github.com/waydabber/BetterDisplay#readme)!
+### Screenshots (Preferences)
+
+
+
## How to install and use the app
1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases)
@@ -59,21 +68,7 @@ For additional features, more advanced brightness control with XDR/HDR brightnes
7. You can set up custom keyboard shortcuts under the `Keyboard` in Preferences (the app uses Apple media keys by default).
8. If you have any questions, go to [Discussions](https://github.com/MonitorControl/MonitorControl/discussions)!
-## Contributing to the project
-
-- You can help out [by contributiong to the project with your one-time donation or by being a regular Sponsor](https://opencollective.com/monitorcontrol)!
-- If you want, you can fork the code, make improvements and submit a pull request to improve the app. Accepting a PR is solely in the hands of the maintainer - before making fundamental changes expecting it to be accepted, please consult the maintainer of the project!
-
-## Screenshots (Preferences)
-
-
-
-## macOS compatibility
+### macOS compatibility
| MonitorControl version | macOS version |
| ---------------------- | ----------------- |
@@ -85,7 +80,7 @@ _* With some limitations - full functionality available on macOS 11 Big Sur or n
For macOS Sequoia compatibility [v4.3.2 or newer](https://github.com/MonitorControl/MonitorControl/releases) is required!
-## Supported displays
+### Supported displays
- Most modern LCD displays from all major manufacturers supported implemented DDC/CI protocol via USB-C, DisplayPort, HDMI, DVI or VGA to allow for hardware backlight and volume control.
- Apple displays and built-in displays are supported using native protocols.
@@ -103,6 +98,12 @@ Compatibility with
- f.lux users: please activate `Avoid gamma table manipulation` under `Preferences` ยป `Displays`! This step is not needed if you use Night Shift.
- [BetterDisplay](https://betterdisplay.pro/) users: either activate `Avoid gamma table manipulation` in MonitorControl or turn off `Allow color table adjustments` in BetterDisplay (under Settings/Displays/Overview). You might want to disable native keyboard control either in MonitorControl or BetterDisplay, depending on which app you want to use for brightness control and dimming.
+## Contributing to the project
+
+- You can help out [by contributiong to the project with your one-time donation or by being a regular Sponsor](https://opencollective.com/monitorcontrol)!
+- If you want, you can fork the code, make improvements and submit a pull request to improve the app. Accepting a PR is solely in the hands of the maintainer - before making fundamental changes expecting it to be accepted, please consult the maintainer of the project!
+
+
## How to build
### Required
@@ -131,11 +132,13 @@ git clone https://github.com/MonitorControl/MonitorControl.git
- [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts)
- [Sparkle](https://github.com/sparkle-project/Sparkle)
-## Maintainer
+## Hall of Honor
+
+### Current maintainer of the project
- [@waydabber](https://github.com/waydabber), developer of [BetterDisplay](https://github.com/waydabber/BetterDisplay#readme).
-## Thanks
+### Former maintainers, special contributors
- [@the0neyouseek](https://github.com/the0neyouseek) - previous (now honorary) maintainer
- [@JoniVR](https://github.com/JoniVR) - previous (now honorary) maintainer