From 6f517fd79d5bb045bdd864321e080494fa83ac8a Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Tue, 26 Jan 2021 09:08:50 +0100
Subject: [PATCH] add documentation

---
 README.md | 79 ++++++++++++++++++++++++-------------------------------
 1 file changed, 34 insertions(+), 45 deletions(-)

diff --git a/README.md b/README.md
index 8c02858..2a6fdd7 100644
--- a/README.md
+++ b/README.md
@@ -10,81 +10,70 @@ Files loaded:
 * `$HOME/.config/monitordisplay/config.ini`
 * `$HOME/.monitordisplay`
 
-### Screens
+### Screens examples
 
 ```
-[screen:HUMAIN_SCREEN_NAME1]
-name=SYSTEM_SCREEN_NAME1
+[screen:LaptopScreen]
+name=eDP1
 resolutionX=1920
 resolutionY=1080
 
-[screen:HUMAIN_SCREEN_NAME2]
-name=SYSTEM_SCREEN_NAME2
-resolutionX=1024
-resolutionY=768
-
-[screen:HUMAIN_SCREEN_NAME3]
-name=SYSTEM_SCREEN_NAME2
+[screen:DisplayPort]
+name=eDP2
 resolutionX=1920
 resolutionY=1080
+
+[screen:HDMI]
+name=hdmi
+resolutionX=1920
+resolutionY=1080
+
+[screen:TV]
+name=hdmi
+resolutionX=1920
+resolutionY=900
 ```
 
 ### Modes
 
 ```
-[mode:MODE_NAME]
-config[foo]=HUMAIN_SCREEN_NAME1,HUMAIN_SCREEN_NAME2
-config[bar]=HUMAIN_SCREEN_NAME2,HUMAIN_SCREEN_NAME1
-primary=HUMAIN_SCREEN_NAME1
+[mode:Home]
+config[table]=TV,LaptopScreen
+config[sofa]=LaptopScreen,TV
+primary=TV
 
-[mode:MODE_NAME2]
-config[]=HUMAIN_SCREEN_NAME1,HUMAIN_SCREEN_NAME3
-config[]=HUMAIN_SCREEN_NAME1,HUMAIN_SCREEN_NAME3
+[mode:Work]
+config[]=LaptopScreen,DisplayPort,HDMI
+config[]=LaptopScreen
 ```
 
 Usage
-----
+-----
 
 ```
-$ monitordisplay -m MODE_NAME
+$ monitordisplay -m Home # same as `monitordisplay -m Home -t table`
 ```
 
 …which equals:
 
 ```
 $ xrand \
-	--output SYSTEM_SCREEN_NAME1 --primary --mode 1920x1080 --pos 0x0 \
-	--output SYSTEM_SCREEN_NAME2 --mode 1024x768 --pos 1920x0 \
-	--output SYSTEM_SCREEN_NAME3 --off
+	--output hdmi --primary --mode 1920x1080 --pos 0x0 \
+	--output eDP1 --mode 1920x1080 --pos 1920x0 \
+	--output eDP2 --off
 ```
 
-Then you can run:
+Then you can run this command to change the applied config:
 
 ```
-$ monitordisplay -t 
-# OR
-$ monitordisplay -tbar
+$ monitordisplay -t # -> same as `monitordisplay -m Home -t sofa`
+$ monitordisplay -t # -> same as `monitordisplay -m Home -t table`
+$ monitordisplay -t # -> same as `monitordisplay -m Home -t sofa`
+$ monitordisplay -t sofa # -> same as `monitordisplay -m Home -t sofa`
 ```
 
-…which equals:
+You can disable `--off` with `-s` and you can test with the parameter `-n`.
 
 ```
-$ xrand \
-	--output SYSTEM_SCREEN_NAME2 --mode 1024x768 --pos 0x0 \
-	--output SYSTEM_SCREEN_NAME1 --mode 1920x1080 --primary --pos 1024x0 \
-	--output SYSTEM_SCREEN_NAME3 --off
-```
-
-You can remove the parameter `--off` with `-s`:
-
-```
-$ monitordisplay -m MODE_NAME -s
-```
-
-It equals:
-
-```
-$ xrand \
-	--output SYSTEM_SCREEN_NAME1 --primary --mode 1920x1080 --pos 0x0 \
-	--output SYSTEM_SCREEN_NAME2 --mode 1024x768 --pos 1920x0
+$ monitordisplay -s -n -m MODE_NAME
 ```