From 9d548617a6ff3f85b7731775f4df9b6a6cee3906 Mon Sep 17 00:00:00 2001
From: Christian Klinger
Date: Wed, 18 May 2016 13:36:50 +0200
Subject: added sample scripts and README.

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4e62449
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Pool Video Switch 2
+======================================================
+Developer and Integrator documentation
+------------------------------------------------------
+
+### Configuration files
+
+### Lock/Unlock Scripts
+The functionality of PVS client(`pvsclient`) can be extended by providing
+additional shell scripts that are executed on certain events.
+
+When the PVS client receives the message from the manager to lock the screen it
+executes `lock.sh` in the configuration directory (`/opt/openslx/pvs2`). When it
+receives an unlock message the client executes `unlock.sh` in the same
+directory.
+
+We suggest to implement additional locking measures in these files.  In the
+`sample_configuration` folder of this repository you can find 2 scripts that use
+`xinput` to disable (enable) the keyboard so that users cannot (even when the
+keyboard input is grabbed by VMWare Player) type while the screen is locked.
+
+
+### Network Setup
+
-- 
cgit v1.2.3-55-g7522