|
1 | | -<img src=".github/Icon-1024.png" width="175" alt="App icon" align="left"/> |
2 | | - |
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 | | -Shows native brightness and volume OSDs as well!</b> |
9 | | -</p> |
10 | | - |
11 | | -<br/> |
12 | | - |
13 | | -<div align="center"> |
14 | | -<!-- shields --> |
15 | | -<!-- downloads --> |
16 | | -<a href="https://github.com/MonitorControl/MonitorControl/releases"> |
17 | | -<img src="https://img.shields.io/github/downloads/MonitorControl/MonitorControl/total.svg?style=flat" alt="downloads"/> |
18 | | -</a> |
19 | | -<!-- version --> |
20 | | -<a href="https://github.com/MonitorControl/MonitorControl/releases"> |
21 | | -<img src="https://img.shields.io/github/release-pre/MonitorControl/MonitorControl.svg?style=flat" alt="latest version"/> |
22 | | -</a> |
23 | | -<!-- license --> |
24 | | -<a href="https://github.com/MonitorControl/MonitorControl/blob/master/License.txt"> |
25 | | -<img src="https://img.shields.io/github/license/MonitorControl/MonitorControl.svg?style=flat" alt="license"/> |
26 | | -</a> |
27 | | -<!-- platform --> |
28 | | -<a href="https://github.com/MonitorControl/MonitorControl"> |
29 | | -<img src="https://img.shields.io/badge/platform-macOS-lightgrey.svg?style=flat" alt="platform"/> |
30 | | -</a> |
31 | | -<!-- backers --> |
32 | | -<a href="https://opencollective.com/monitorcontrol"> |
33 | | -<img src="https://opencollective.com/monitorcontrol/tiers/badge.svg" alt="backers"/> |
34 | | -</a> |
35 | | - |
36 | | -<br/> |
37 | | -<br/> |
38 | | - |
39 | | -</div> |
40 | | - |
41 | | -<img src=".github/screenshot.png" width="840" alt="Screenshot"/><br/> |
42 | | - |
43 | | -<hr> |
44 | | - |
45 | | -## Download |
46 | | - |
47 | | -Go to [Releases](https://github.com/MonitorControl/MonitorControl/releases) and download the latest `.dmg` |
48 | | - |
49 | | -## Compatibility |
50 | | - |
51 | | -- macOS Big Sur (`macOS 11`) and newer are supported |
52 | | -- Current version is compatible with macOS Catalina (`10.15`) as well (with some limitations). |
53 | | - |
54 | | -_(Note: you can download [version 2.1.0](https://github.com/MonitorControl/MonitorControl/releases/tag/v2.1.0) for Sierra `10.12` and [version 3.1.1](https://github.com/MonitorControl/MonitorControl/releases/tag/v3.1.1) for Mojave `10.14` support)_ |
55 | | - |
56 | | -## How to help |
57 | | - |
58 | | -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. |
59 | | - |
60 | | -## How to build |
61 | | - |
62 | | -### Required |
63 | | - |
64 | | -- Xcode |
65 | | -- [Swiftlint](https://github.com/realm/SwiftLint) |
66 | | -- [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) |
67 | | -- [BartyCrouch](https://github.com/Flinesoft/BartyCrouch) (for updating localizations) |
68 | | - |
69 | | -Clone the project via this Terminal command: |
70 | | - |
71 | | -``` |
72 | | -git clone https://github.com/MonitorControl/MonitorControl.git |
73 | | -``` |
74 | | - |
75 | | -If you want to clone one of the branches, add `--single-branch --branch [branchname]` after the `clone` option. |
76 | | - |
77 | | -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: |
78 | | - |
79 | | -`File > Packages > Resolve Package Versions` |
80 | | - |
81 | | -(In earlier XCode versions `Packages` menu is titled `Swift Packages`) |
82 | | - |
83 | | -### Third party dependencies |
84 | | - |
85 | | -- [MediaKeyTap](https://github.com/MonitorControl/MediaKeyTap) |
86 | | -- [Preferences](https://github.com/sindresorhus/Preferences) |
87 | | -- [SimplyCoreAudio](https://github.com/rnine/SimplyCoreAudio) |
88 | | -- [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts) |
89 | | -- [Sparkle](https://github.com/sparkle-project/Sparkle) |
90 | | - |
91 | | -## Contributors |
92 | | - |
93 | | -- [@the0neyouseek](https://github.com/the0neyouseek) |
94 | | -- [@JoniVR](https://github.com/JoniVR) |
95 | | -- [@waydabber](https://github.com/waydabber) |
96 | | - |
97 | | -## Thanks |
98 | | - |
99 | | -- [@bluejamesbond](https://github.com/bluejamesbond/) (original developer) |
100 | | -- [@Tyilo](https://github.com/Tyilo/) (fork) |
101 | | -- [@Bensge](https://github.com/Bensge/) - (used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness)) |
102 | | -- [@nhurden](https://github.com/nhurden/) (for the original MediaKeyTap) |
103 | | -- [@kfix](https://github.com/kfix/ddcctl) (for ddcctl) |
104 | | -- [@reitermarkus](https://github.com/reitermarkus) (for DDC.Swift) |
105 | | -- [@zhuowei](https://github.com/zhuowei) (figured out M1 I²C communication) |
106 | | -- [@tao-j](https://github.com/tao-j) (figured out M1 I²C write) |
107 | | -- [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats) |
108 | | -- [javierocasio](https://www.deviantart.com/javierocasio) (app icon background) |
| 1 | +This branch is reserved for the project GitHub pages. |
0 commit comments