diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 5dc023e..8193d2d 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,4 +1,3 @@ # These are supported funding model platforms -github: MonitorControl open_collective: monitorcontrol diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index aa4f211..0000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: CI - -on: - push: - branches: [main] - pull_request: - branches: [main] - -jobs: - build: - runs-on: macos-latest - steps: - - uses: actions/checkout@v4 - - - name: xcodebuild - uses: sersoft-gmbh/xcodebuild-action@v3 - with: - project: MonitorControl.xcodeproj - scheme: MonitorControl - destination: platform=macOS - action: build - lint: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: SwiftLint - uses: norio-nomura/action-swiftlint@3.2.1 - env: - DIFF_BASE: ${{ github.base_ref }} - with: - args: --strict diff --git a/README.md b/README.md index b7fcf25..8934b5a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ App icon
-

MonitorControl - for Apple Silicon and Intel

+

MonitorControl - now compatible with macOS Sequoia

Controls your external display brightness and volume and shows native OSD. Use menubar extra sliders or the keyboard, including native Apple keys!

Download for macOS @@ -10,27 +10,10 @@ Use menubar extra sliders or the keyboard, including native Apple keys!



- - - -downloads - - - -latest version - - - -license - - - -platform - - - -backers - +downloads +latest version +license +platform

@@ -63,18 +46,9 @@ brew install MonitorControl - Simple, unobtrusive UI to blend in to the general aesthetics of macOS. - **One of the best app of its kind, completely FREE.** -## How to install and use the app +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)! -1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases) -2. Copy the MonitorControl app file from the .DMG to your Applications folder -3. Click on the `MonitorControl` app file -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). -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. -6. Open `Preferences…` for customization options (enable `Show advanced settings` for even more options). -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)! - -## Screenshots (Preferences) +### Screenshots (Settings)
Screenshot @@ -83,7 +57,18 @@ brew install MonitorControl Screenshot
-## macOS compatibility +## How to install and use the app + +1. [Download the app](https://github.com/MonitorControl/MonitorControl/releases) +2. Copy the MonitorControl app file from the .dmg file to your Applications folder +3. Click on the `MonitorControl` app +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). +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. +6. Open `Settings…` for customization options (enable `Show advanced settings` for even more options). +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)! + +### macOS compatibility | MonitorControl version | macOS version | | ---------------------- | ----------------- | @@ -93,7 +78,9 @@ brew install MonitorControl _* With some limitations - full functionality available on macOS 11 Big Sur or newer._ -## Supported displays +For macOS Sequoia compatibility [v4.3.2 or newer](https://github.com/MonitorControl/MonitorControl/releases) is required! + +### 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. @@ -109,7 +96,13 @@ Notable exceptions for hardware control compatibility: 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 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. +- [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 @@ -139,19 +132,21 @@ git clone https://github.com/MonitorControl/MonitorControl.git - [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts) - [Sparkle](https://github.com/sparkle-project/Sparkle) -## Maintainers +## Hall of Honor -- [@the0neyouseek](https://github.com/the0neyouseek) -- [@JoniVR](https://github.com/JoniVR) -- [@waydabber](https://github.com/waydabber) +### Current maintainer of the project -## Thanks +- [@waydabber](https://github.com/waydabber), developer of [BetterDisplay](https://github.com/waydabber/BetterDisplay#readme). +### Former maintainers, special contributors + +- [@the0neyouseek](https://github.com/the0neyouseek) - previous (now honorary) maintainer +- [@JoniVR](https://github.com/JoniVR) - previous (now honorary) maintainer +- [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats) - [@mathew-kurian](https://github.com/mathew-kurian/) (original developer) - [@Tyilo](https://github.com/Tyilo/) (fork) - [@Bensge](https://github.com/Bensge/) - (used some code from his project [NativeDisplayBrightness](https://github.com/Bensge/NativeDisplayBrightness)) - [@nhurden](https://github.com/nhurden/) (for the original MediaKeyTap) - [@kfix](https://github.com/kfix/ddcctl) (for ddcctl) - [@reitermarkus](https://github.com/reitermarkus) (for Intel DDC support) -- [@alin23](https://github.com/alin23) (generally spearheaded M1 DDC support and figured out a many of the caveats) - [javierocasio](https://www.deviantart.com/javierocasio) (app icon background)