feat: add readme and clean up comments and code quality. Also update metadata so that it reads better in settings

2026-06-29 21:35:13 -04:00
parent 2c0a09efb0
commit 408288f79e
9 changed files with 58 additions and 38 deletions
@@ -0,0 +1,47 @@
+# DDC Brightness Control
+
+This project aims to be a simple and easy to use DDC brightness control plugin for Gnome
+
+![img.png](attachments/panel.png)
+
+## Features
+
+- Brightness control via panel
+- Adjustable keybindings for brightness controls
+    - Active screen detection
+    - By default, keybinding is alt+shift+f1/f2 for down/up on the active display
+- Display linking if you want to adjust all displays at once
+
+## Planned Features?
+
+- Would be nice to get this added to the system status menu at some point isntead of its own dot
+- Support for direct i2c or better ddc controllers (not ddcutil)
+- You tell me
+
+## Installation
+
+(Examples use arch, but all packages should be available on other distros as well)
+
+Be sure to have [ddcutil](https://www.ddcutil.com/) installed it is a hard requirement for now
+
+Also, if installing from source install just which is the chosen command runner for this project
+
+```bash
+sudo pacman -Syu ddcutil just
+```
+
+Add your user to the i2c group so it can use i2c without root and reboot/login+out
+
+```bash 
+sudo usermod -aG i2c $USER
+reboot
+```
+
+Now install the extension from version control
+(until we get to the gnome extension store)
+
+```bash 
+
+```
+
+