aboutsummaryrefslogtreecommitdiff
path: root/pluginhost~/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pluginhost~/README.txt')
-rw-r--r--pluginhost~/README.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/pluginhost~/README.txt b/pluginhost~/README.txt
new file mode 100644
index 0000000..aab7983
--- /dev/null
+++ b/pluginhost~/README.txt
@@ -0,0 +1,38 @@
+pluginhost~ - a plugin host for Pure Data
+==========================================
+
+This directory (pluginhost) contains sourcecode and possibly binaries for a plugin host for Pure Data. It currently supports the following plugin types:
+
+ LADSPA: http://www.ladspa.org/
+ DSSI: http://dssi.sourceforge.net/
+
+The functionality of the external is demonstrated in in the help patch (pluginhost/doc/pluginhost~-help.pd).
+
+Requirements
+------------
+
+To compile pluginhost~ the following are required;
+
+pd header (m_pd.h) >= 0.37
+
+The help patch requires:
+
+PD >= 0.39
+
+Installation
+------------
+
+From the same directory as the makefile type:
+
+make
+make install (as root)
+
+Once compiled the binary file and help file should be placed in directories that are included in Pure Data's search path.
+
+License
+-------
+
+All files included in the pluginhost/src/ directory, and all binary files (if included) are licensed under the GNU GPL Version 2 (see gpl.txt for details).
+
+All files included in the pluginhost/include/ directory are licensed under the GNU Lesser General Public License (see lesser.txt for details).
+