diff --git a/README.md b/README.md index fd1fe9c..d14a4b1 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,18 @@ brightnessctl ## Configuring ```LevelSteps``` Sets amount of brightness steps, recomended to match refeshrate -```AnimationDelay``` Speed of the brightness animation(how fast it goes between setps), recomended screen refreshrate in seconds +```AnimationDelay``` Speed of the brightness animation(delay between each step), recomended screen refreshrate in seconds -```MaxScreenBrightness``` The highest value your screen supports, check your /sys/class/backlight/intel_backlight/brightness +```MaxScreenBrightness``` The highest value your screen supports, check ```/sys/class/backlight/intel_backlight/brightness``` on framework laptops ```SensorDelay``` Time in seconds the script will wait to check the sensor for a luminess change ```MinimunBrightness``` The minimum screen brightness, recomended minumim 001 so the backlight dosn't turn off -```SensorToDisplayScale``` The ratio from sensor to screen brighness, recommended minimum 24 for 12th gen framework laptops. The script will limit the max values to MaxScreenBrighness +```SensorToDisplayScale``` The ratio from sensor to screen brighness, recommended minimum 24 for 12th gen framework laptops. The script will limit the max values to MaxScreenBrighness + +~~ Other things to note + +```Light``` The file where your lightsensor has its current value + +```CurrentBirghtness``` The file where your screen stores its current brightness