Skip to content

Commit c77ec0e

Browse files
waydabberwaydabber
committed
Merge remote-tracking branch 'refs/remotes/origin/develop'
2 parents e5b672e + b16b2b5 commit c77ec0e

File tree

3 files changed

+37
-76
lines changed

3 files changed

+37
-76
lines changed

‎.github/FUNDING.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
# These are supported funding model platforms
22

3-
github: MonitorControl
43
open_collective: monitorcontrol

‎.github/workflows/main.yml‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎README.md‎

Lines changed: 37 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<img src=".github/Icon-cropped.png" width="200" alt="App icon" align="left"/>
22

33
<div>
4-
<h3>MonitorControl - for Apple Silicon and Intel</h3>
4+
<h3>MonitorControl - now compatible with macOS Sequoia</h3>
55
<p>Controls your external display brightness and volume and shows native OSD.
66
Use menubar extra sliders or the keyboard, including native Apple keys!</p>
77
<a href="https://github.com/MonitorControl/MonitorControl/releases"><img src=".github/macos_badge_noborder.png" width="175" alt="Download for macOS"/></a>
@@ -10,27 +10,10 @@ Use menubar extra sliders or the keyboard, including native Apple keys!</p>
1010
<br/><br/>
1111

1212
<div align="center">
13-
<!-- shields -->
14-
<!-- downloads -->
15-
<a href="https://github.com/MonitorControl/MonitorControl/releases">
16-
<img src="https://img.shields.io/github/downloads/MonitorControl/MonitorControl/total.svg?style=flat" alt="downloads"/>
17-
</a>
18-
<!-- version -->
19-
<a href="https://github.com/MonitorControl/MonitorControl/releases">
20-
<img src="https://img.shields.io/github/release-pre/MonitorControl/MonitorControl.svg?style=flat" alt="latest version"/>
21-
</a>
22-
<!-- license -->
23-
<a href="https://github.com/MonitorControl/MonitorControl/blob/master/License.txt">
24-
<img src="https://img.shields.io/github/license/MonitorControl/MonitorControl.svg?style=flat" alt="license"/>
25-
</a>
26-
<!-- platform -->
27-
<a href="https://github.com/MonitorControl/MonitorControl">
28-
<img src="https://img.shields.io/badge/platform-macOS-lightgrey.svg?style=flat" alt="platform"/>
29-
</a>
30-
<!-- backers -->
31-
<a href="https://opencollective.com/monitorcontrol">
32-
<img src="https://opencollective.com/monitorcontrol/tiers/badge.svg" alt="backers"/>
33-
</a>
13+
<a href="https://github.com/MonitorControl/MonitorControl/releases"><img src="https://img.shields.io/github/downloads/MonitorControl/MonitorControl/total.svg?style=flat" alt="downloads"/></a>
14+
<a href="https://github.com/MonitorControl/MonitorControl/releases"><img src="https://img.shields.io/github/release-pre/MonitorControl/MonitorControl.svg?style=flat" alt="latest version"/></a>
15+
<a href="https://github.com/MonitorControl/MonitorControl/blob/master/License.txt"><img src="https://img.shields.io/github/license/MonitorControl/MonitorControl.svg?style=flat" alt="license"/></a>
16+
<a href="https://github.com/MonitorControl/MonitorControl"><img src="https://img.shields.io/badge/platform-macOS-blue.svg?style=flat" alt="platform"/></a>
3417

3518
<br/>
3619
<br/>
@@ -63,18 +46,9 @@ brew install MonitorControl
6346
- Simple, unobtrusive UI to blend in to the general aesthetics of macOS.
6447
- **One of the best app of its kind, completely FREE.**
6548

66-
## How to install and use the app
49+
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)!
6750

68-
1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases)
69-
2. Copy the MonitorControl app file from the .DMG to your Applications folder
70-
3. Click on the `MonitorControl` app file
71-
4. Add the app to `Accessibility` under `System Settings` » `Privacy & Security` as prompted (this is required only if you wish to use the native Apple keyboard brightness and media keys - if this is not the case, you can safely skip this step).
72-
5. Use your keyboard or the sliders in the app menu (a brightness symbol in the macOS menubar as shown on the screenshot above) to control your displays.
73-
6. Open `Preferences…` for customization options (enable `Show advanced settings` for even more options).
74-
7. You can set up custom keyboard shortcuts under the `Keyboard` in Preferences (the app uses Apple media keys by default).
75-
8. If you have any questions, go to [Discussions](https://github.com/MonitorControl/MonitorControl/discussions)!
76-
77-
## Screenshots (Preferences)
51+
### Screenshots (Settings)
7852

7953
<div align="center">
8054
<img src=".github/pref_1.png" width="392" alt="Screenshot"/>
@@ -83,7 +57,18 @@ brew install MonitorControl
8357
<img src=".github/pref_4.png" width="392" alt="Screenshot"/>
8458
</div>
8559

86-
## macOS compatibility
60+
## How to install and use the app
61+
62+
1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases)
63+
2. Copy the MonitorControl app file from the .dmg file to your Applications folder
64+
3. Click on the `MonitorControl` app
65+
4. Add the app to `Accessibility` under `System Settings` » `Privacy & Security` as prompted (this is required only if you wish to use the native Apple keyboard brightness and media keys - if this is not the case, you can safely skip this step).
66+
5. Use your keyboard or the sliders in the app menu (a brightness symbol in the macOS menubar as shown on the screenshot above) to control your displays.
67+
6. Open `Settings…` for customization options (enable `Show advanced settings` for even more options).
68+
7. You can set up custom keyboard shortcuts under the `Keyboard` in Preferences (the app uses Apple media keys by default).
69+
8. If you have any questions, go to [Discussions](https://github.com/MonitorControl/MonitorControl/discussions)!
70+
71+
### macOS compatibility
8772

8873
| MonitorControl version | macOS version |
8974
| ---------------------- | ----------------- |
@@ -93,7 +78,9 @@ brew install MonitorControl
9378

9479
_* With some limitations - full functionality available on macOS 11 Big Sur or newer._
9580

96-
## Supported displays
81+
For macOS Sequoia compatibility [v4.3.2 or newer](https://github.com/MonitorControl/MonitorControl/releases) is required!
82+
83+
### Supported displays
9784

9885
- 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.
9986
- Apple displays and built-in displays are supported using native protocols.
@@ -109,7 +96,13 @@ Notable exceptions for hardware control compatibility:
10996
Compatibility with
11097

11198
- f.lux users: please activate `Avoid gamma table manipulation` under `Preferences` » `Displays`! This step is not needed if you use Night Shift.
112-
- [BetterDisplay](https://betterdisplay.pro/) users: either activate `Avoid gamma table manipulation` in MonitorControl or turn off `Allow color 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.
99+
- [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.
100+
101+
## Contributing to the project
102+
103+
- You can help out [by contributiong to the project with your one-time donation or by being a regular Sponsor](https://opencollective.com/monitorcontrol)!
104+
- 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!
105+
113106

114107
## How to build
115108

@@ -139,19 +132,21 @@ git clone https://github.com/MonitorControl/MonitorControl.git
139132
- [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts)
140133
- [Sparkle](https://github.com/sparkle-project/Sparkle)
141134

142-
## Maintainers
135+
## Hall of Honor
136+
137+
### Current maintainer of the project
143138

144-
- [@the0neyouseek](https://github.com/the0neyouseek)
145-
- [@JoniVR](https://github.com/JoniVR)
146-
- [@waydabber](https://github.com/waydabber)
139+
- [@waydabber](https://github.com/waydabber), developer of [BetterDisplay](https://github.com/waydabber/BetterDisplay#readme).
147140

148-
## Thanks
141+
### Former maintainers, special contributors
149142

143+
- [@the0neyouseek](https://github.com/the0neyouseek) - previous (now honorary) maintainer
144+
- [@JoniVR](https://github.com/JoniVR) - previous (now honorary) maintainer
145+
- [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats)
150146
- [@mathew-kurian](https://github.com/mathew-kurian/) (original developer)
151147
- [@Tyilo](https://github.com/Tyilo/) (fork)
152148
- [@Bensge](https://github.com/Bensge/) - (used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness))
153149
- [@nhurden](https://github.com/nhurden/) (for the original MediaKeyTap)
154150
- [@kfix](https://github.com/kfix/ddcctl) (for ddcctl)
155151
- [@reitermarkus](https://github.com/reitermarkus) (for Intel DDC support)
156-
- [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats)
157152
- [javierocasio](https://www.deviantart.com/javierocasio) (app icon background)

0 commit comments

Comments
 (0)