- Improve monitor.conf formatting for clarity.

- Updated HDR test logic to specify Wayland requirement.
- Fixed README setup instructions for creating a symlink.

README.md

@@ -43,7 +43,7 @@ cd hdr-helper
 # Not all distros will create the below path, create it assuming that it doesn't
 # exist on your system
 mkdir ~/.local/bin/
-ln -s hdr-helper ~/.local/bin/
+ln -s $PWD/hdr-helper ~/.local/bin/
 chmod +x ~/.local/bin/hdr-helper
 
 # You will also need to copy monitor.conf into ~/.config/hdr-helper

hdr-helper

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-_VERSION=1.2.1.0
+_VERSION=1.2.1.1
 CONFIG_PATH="$HOME/.config/hdr-helper/"
 CONFIG_FILE="$CONFIG_PATH/monitor.conf"
 CURR_BRIGHT_LVL_PATH="/tmp/hdr-helper/"
@@ -70,7 +70,8 @@ if [[ $HDR_CONTEXT == *"incapable"* ]]; then
   echo "❌ HDR capabilities are either disabled or not supported on your current display."
   echo ""
   echo "Please check the correct display is configured in monitor.conf and that"
-  echo "HDR is both supported and enabled."
+  echo "HDR is both supported and enabled. Wayland is required as X11 does not have"
+  echo "any support for HDR."
   echo ""
 elif [[ $HDR_CONTEXT == *"enabled"* || *"disabled"* ]]; then
   echo "✅ HDR capabilities are supported on your current display."

monitor.conf

@@ -1,10 +1,17 @@
-#                           Copy this file into ~/.config/hdr-helper
+# Copy this file into ~/.config/hdr-helper
 #
-#                               # Example Value | Description
-#                               #---------------|--------------------------------------------------------------------------------#
-MONITOR=                        # DP-1          | Enter your monitor ID from xrandr.
-NATIVE_RES=                     # 3440x1440@165 | Enter your native monitor resolution followed by the refresh rate
-TEMP_RES=                       # 2560x1440@144 | Enter a different resolution or refresh rate from your native.
-#SDR_TARGET_BRIGHTNESS=0        # 100           | Enter a target SDR brightness level for your display when in HDR mode [0,1-100].
-#SDR_TARGET_BRIGHTNESS_NITS=    # 450           | Enter a target SDR brightness level in nits when in HDR mode. Please refer to you
-                                #               | display's specs for this information.
+# Example Value | Description
+#---------------|--------------------------------------------------------------------------------#
+
+# DP-1          | Enter your monitor ID from xrandr.
+MONITOR=
+# 3440x1440@165 | Enter your native monitor resolution followed by the refresh rate         
+NATIVE_RES=
+# 2560x1440@144 | Enter a different resolution or refresh rate from your native.
+TEMP_RES=
+
+### Optional Values ###
+# 100           | Enter a target SDR brightness level for your display when in HDR mode [0,1-100].                   
+#SDR_TARGET_BRIGHTNESS=0
+# 450           | Enter a target SDR brightness level in nits when in HDR mode. Please refer to you display's specs for this information.
+#SDR_TARGET_BRIGHTNESS_NITS=