Place functions before if __name__

[dispcfg.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..390ab85
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+configure_displays should be ran here:
+
+* On resume from suspend
+* On key press from window manager (shortcut) -- currently $mod+p in ~/.i3/config
+* On login startup -- currently ~/.i3/startup
+
+The simple /etc/pm/sleep.d/50_configure-displays script:
+----
+#!/bin/sh
+
+# Configure displays on resume and thaw
+
+case "$1" in
+       resume|thaw)
+               configure_displays
+               ;;
+esac
+----