Merge pull request #56 from nazar-pc/patch-1

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index a95e19e43e06f837e3c6e53abc61fb0d6b0eb234..3fddb457b7984ed1afe18524232f668df2329aec 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,8 +34,11 @@ Contributors to this version of autorandr are:
 
 * Alexander Wirt
 * Chris Dunder
+* Daniel Hahler
 * Maciej Sitarz
+* Mathias Svensson
 * Matthew R Johnson
+* Nazar Mokrynskyi
 * Phillip Berndt
 * Rasmus Wriedt Larsen
 * Stefan Tomanek
@@ -45,6 +48,14 @@ Contributors to this version of autorandr are:
 * stormc
 * tachylatus
 * andersonjacob
+* Simon Wydooghe
+
+## Installation/removal
+For Debian-based distributives (including Ubuntu) it is recommended to call `make deb` to obtain a package that can be installed and removed with `dpkg`.
+
+On other distributives you can install autorandr by calling `make install` and remove it by calling `make uninstall`.
+
+If you can contribute packaging script for other distributives, we will appreciate it.
 
 ## How to use
 
@@ -82,9 +93,20 @@ To change this behaviour and switch to a fallback configuration, specify
 `--default <profile>`.
 
 Another script called `postswitch` can be placed in the directory
-`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as well as in all profile directories: The scripts are executed
-after a mode switch has taken place and can notify window managers or other
-applications about it.
-
-To install autorandr call `make install`, define your setup and then call
-`make hotplug` to install hotplug scripts.
+`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as
+well as in all profile directories: The scripts are executed after a mode
+switch has taken place and can notify window managers or other applications
+about it. The same holds for `preswitch`, which is executed before the switch
+takes place, and `postsave`, which is executed after a profile was
+stored/altered.
+
+All scripts can also be placed in any of the `$XDG_CONFIG_DIRS`. In addition to
+the script names themselves, any executables in subdirectories named
+`script_name.d` (e.g. `postswitch.d`) are executed as well. In scripts, some of
+autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`.
+The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
+
+## Apply configuration on login
+With recent versions of autorandr you typically do not need to add autorandr to `~/.xprofile`, since an autostart configuration file will be installed at `/etc/xdg/autostart/autorandr.desktop` by the makefile. It will select an appropriate profile automatically.
+
+If you need to customize this behaviour, you can always disable or modify it by placing an alternative desktop file with the same name in `~/.config/autostart` or by using a GUI configuration tool for autostart like `gnome-session-properties`.