Skip to content

Commit 2c2b7ce

Browse files
authored
Updated README with more information (MonitorControl#698)
1 parent 0a502c7 commit 2c2b7ce

File tree

9 files changed

+55
-20
lines changed

9 files changed

+55
-20
lines changed

.github/Icon-1024.png

-609 KB
Binary file not shown.

.github/Icon-cropped.png

744 KB
Loading

.github/macos_badge_noborder.png

13.5 KB
Loading

.github/pref_1.png

582 KB
Loading

.github/pref_2.png

504 KB
Loading

.github/pref_3.png

561 KB
Loading

.github/pref_4.png

516 KB
Loading

.github/pref_5.png

416 KB
Loading

README.md

Lines changed: 55 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
<img src=".github/Icon-1024.png" width="175" alt="App icon" align="left"/>
1+
<img src=".github/Icon-cropped.png" width="220" alt="App icon" align="left"/>
22

3-
<h2>MonitorControl - Now with Apple Silicon support</h2>
4-
5-
<p>
6-
<b>Control your external display brightness and volume<br>
7-
Use menulet sliders or the native Apple keyboard keys<br>
8-
Behaves like native, with (optional) brightness & volume OSD</b>
9-
</p>
3+
<div>
4+
<h2>MonitorControl - for Apple Silicon and Intel</h2>
5+
<p>Controls your external display brightness and volume and shows native OSD.<br/>
6+
Use menulet sliders or the keyboard, including native Apple keys!</p>
7+
<a href="https://github.com/MonitorControl/MonitorControl/releases"><img src=".github/macos_badge_noborder.png" width="175" alt="Download for macOS"/></a>
8+
</div>
109

11-
<br/>
10+
<br/><br/>
1211

1312
<div align="center">
1413
<!-- shields -->
@@ -36,16 +35,53 @@ Behaves like native, with (optional) brightness & volume OSD</b>
3635
<br/>
3736
<br/>
3837

39-
</div>
38+
<img src=".github/screenshot.png" width="825" alt="Screenshot"/><br/>
4039

41-
<img src=".github/screenshot.png" width="840" alt="Screenshot"/><br/>
40+
</div>
4241

4342
<hr>
4443

4544
## Download
4645

4746
Go to [Releases](https://github.com/MonitorControl/MonitorControl/releases) and download the latest `.dmg`
4847

48+
## Major features
49+
50+
- Control your display's brightness, volume and contrast!
51+
- Shows native OSD for brightness and volume.
52+
- Supports multiple protocols to adjust brightness: DDC for external displays (brightness, contrast, volume), native Apple porotocol for Apple and built-in displays, Gamma table control for software adjustment (recommended for OLED), shade control for AirPlay, Sidecar and Display Link devices.
53+
- Supports smooth brightness transitions.
54+
- Seamlessly combined hardware and software dimming extends dimming beyond the minimum brightness available on your display.
55+
- Synchronize brightness from built-in and Apple screens - replicate Ambient light sensor and touch bar induced changes to a non-Apple external display!
56+
- Sync up all your displays using a single slider or keyboard shortcuts.
57+
- Allows dimming to full black (advanced feature).
58+
- Support for custom keyboard shortcuts as well as standard brightness and media keys on Apple keyboards.
59+
- Dozens of customization options to tweak the inner workings of the app to suit Your hardware and needs (don't forget to enable `Show advanced settings` in app Preferences).
60+
- Modern, stylish and highgly customizable menulet reflecting the design of Control Control introduced in Big Sur.
61+
- Simple, unobstrusive UI to blend in to the general aesthetics of macOS (even the menu icon can be hidden).
62+
- Supports automatic updates for a hassle-free expereince.
63+
- <b>The best app of its kind, completely FREE (donations accepted) with the source code transparently available!</b>
64+
65+
## How to install and use the app
66+
67+
1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases)
68+
2. Copy the MonitorControl app file from the .DMG to your Applications folder
69+
3. Click on the `MonitorControl` app file
70+
4. Add the app to `Accessibility` under `System Preferences` » `Security & Privacy` » `Privacy` 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).
71+
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.
72+
6. Open `Preferences...` for customization options (enable `Show advanced settings` for even more options).
73+
7. You can set up custom keyboard shortcuts under the `Keyboard` in Preferences (the app uses Apple media keys by default).
74+
8. If you have any questions, go to [Discussions](https://github.com/MonitorControl/MonitorControl/discussions)!
75+
76+
## Screenshots (Preferences)
77+
78+
<div align="center">
79+
<img src=".github/pref_1.png" width="410" alt="Screenshot"/>
80+
<img src=".github/pref_3.png" width="410" alt="Screenshot"/><br/>
81+
<img src=".github/pref_4.png" width="410" alt="Screenshot"/>
82+
<img src=".github/pref_2.png" width="410" alt="Screenshot"/><br/>
83+
</div>
84+
4985
## Compatibility
5086

5187
| MonitorControl version | macOS version |
@@ -56,6 +92,8 @@ Go to [Releases](https://github.com/MonitorControl/MonitorControl/releases) and
5692

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

95+
Note to f.lux users: the app is now compatible with [f.lux](https://justgetflux.com) as well - please activate `Avoid gamma table manipulation` under `Preferences` » `Displays` (this option is accessible if advanced settings are enabled)! This is not needed if you use Night Shift.
96+
5997
## How to help
6098

6199
Open [issues](https://github.com/MonitorControl/MonitorControl/issues) if you have a question, an enhancement to suggest or a bug you've found. If you want you can fork the code yourself and submit a pull request to improve the app.
@@ -73,17 +111,16 @@ MonitorControl supports localization. We gladly welcome your contribution with a
73111
- [SwiftFormat](https://github.com/nicklockwood/SwiftFormat)
74112
- [BartyCrouch](https://github.com/Flinesoft/BartyCrouch) (for updating localizations)
75113

76-
Clone the project via this Terminal command:
114+
### Build steps
115+
116+
- Clone the project via this Terminal command:
77117

78118
```sh
79119
git clone https://github.com/MonitorControl/MonitorControl.git
80120
```
81121

82-
If you want to clone one of the branches, add `--single-branch --branch [branchname]` after the `clone` option.
83-
84-
You're all set ! Now open the `MonitorControl.xcodeproj` with Xcode! The dependencies will automatically get downloaded once you open the project. If they don't:
85-
86-
`File > Packages > Resolve Package Versions`
122+
- If you want to clone one of the branches, add `--single-branch --branch [branchname]` after the `clone` option.
123+
- You're all set ! Now open the `MonitorControl.xcodeproj` with Xcode! The dependencies will automatically get downloaded once you open the project. If they don't: `File > Packages > Resolve Package Versions`
87124

88125
### Third party dependencies
89126

@@ -106,8 +143,6 @@ You're all set ! Now open the `MonitorControl.xcodeproj` with Xcode! The depende
106143
- [@Bensge](https://github.com/Bensge/) - (used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness))
107144
- [@nhurden](https://github.com/nhurden/) (for the original MediaKeyTap)
108145
- [@kfix](https://github.com/kfix/ddcctl) (for ddcctl)
109-
- [@reitermarkus](https://github.com/reitermarkus) (for DDC.Swift)
110-
- [@zhuowei](https://github.com/zhuowei) (figured out M1 I²C communication)
111-
- [@tao-j](https://github.com/tao-j) (figured out M1 I²C write)
146+
- [@reitermarkus](https://github.com/reitermarkus) (for Intel DDC support)
112147
- [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats)
113148
- [javierocasio](https://www.deviantart.com/javierocasio) (app icon background)

0 commit comments

Comments
 (0)