aboutsummaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorIOhannes m zmölnig <zmoelnig@users.sourceforge.net>2011-03-01 18:11:29 +0000
committerIOhannes m zmölnig <zmoelnig@users.sourceforge.net>2011-03-01 18:11:29 +0000
commitdcca5a5fcb8f56c74dce164933cc47ed3228ab10 (patch)
tree196e7114f8ee8c86643754f988ffb5fd221f1bb3 /README.txt
parent555fe8dd8097cfbd9ec8cde5cab80bb5aa05234d (diff)
added README
svn path=/trunk/guiplugins/kiosk-plugin/; revision=14993
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..3c47841
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,40 @@
+KIOSK mode for Pure Data
+========================
+
+
+KIOSK mode allows you to enable one or more of the following features
+
+ * hiding the main Pd-window
+ * disabling the menu bar in the patch window
+ * making a patch window to be shown at fullsreen
+ * setting a window name for the patch window (independent of the patch name)
+ * prevent closing of patch windows (using Alt-F4, clicking on the "Close
+ * Window" icon, et al.)
+ * quit Pd when a patch window is closed
+ * disable the (right click) context menu
+ * disable key-bindings (like Ctrl-N)
+ * prevent scroll bars from appearing, even if the patch content does not fit
+ * on a single window
+
+
+you can enable/disable the parts you want to by editing a kiosk.cfg file.
+this config file is searched for in the working directory of Pd, and (if not
+found) in the plugin directory of the kiosk-plugin (usually
+~/pd-externals/kiosk-plugin/)
+
+
+INSTALLATION
+------------
+just copy this directoy to ~/pd-externals/kiosk-plugin/
+it will be automatically used, the next time you start Pd
+
+PREREQUISITES
+-------------
+gui-plugins only work with Pd>=0.43
+
+
+AUTHOR
+------
+IOhannes m zmölnig
+(though the fullscreen part was copied from András Murányi's "fullscreen"
+plugin)