Add a configuration file for default option values

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index 40588558316f32aad26699d2be99d70466254d2d..4d92fedfce87a07e6e6cb11016a38acb7f467780 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,6 +39,7 @@ Contributors to this version of autorandr are:
 * andersonjacob
 * Alexander Wirt
 * Chris Dunder
+* Christoph Gysin
 * Daniel Hahler
 * Maciej Sitarz
 * Mathias Svensson
@@ -108,12 +109,22 @@ Now autorandr can detect which hardware setup is active:
       mobile
       docked (detected)
 
-To automatically reload your setup, just append `--change` to the command line
+To automatically reload your setup:
 
-To manually load a profile, you can use the `--load <profile>` option.
+    $ autorandr --change
+
+To manually load a profile:
+
+    $ autorandr --load <profile>
+
+or simply:
+
+    $ autorandr <profile>
 
 autorandr tries to avoid reloading an identical configuration. To force the
-(re)configuration, apply `--force`.
+(re)configuration:
+
+    $ autorandr --load <profile> --force
 
 To prevent a profile from being loaded, place a script call _block_ in its
 directory. The script is evaluated before the screen setup is inspected, and
@@ -131,6 +142,10 @@ names in your configuration directory to have autorandr use any of them
 as the default configuration without you having to change the system-wide
 configuration.
 
+You can store default values for any option in an INI-file in
+`~/config/autorandr/settings.ini` in a section `config`. The most useful
+candidate for doing that is `skip-options`, if you need it.
+
 ## Hook scripts
 
 Three more scripts can be placed in the configuration directory (as 
@@ -182,6 +197,11 @@ running `xrandr`.
 
 ## Changelog
 
+**autorandr 1.3**
+
+* *2017-11-13* Add a short form for `--load`
+* *2017-11-21* Fix environment stealing in `--batch` mode (See #87)
+
 **autorandr 1.2**
 
 * *2017-07-16* Skip `--panning` unless it is required (See #72)