readme added

svn path=/trunk/externals/iem/pdoctave/; revision=4612

1 files changed, 29 insertions, 0 deletions

diff --git a/Readme.txt b/Readme.txt
new file mode 100644
index 0000000..62f9547
--- /dev/null
+++ b/Readme.txt
@@ -0,0 +1,29 @@
+pdoctave:
+
+pd-octave shall be an interface to octave, mainly in order to access octaves command-line functionality and enourmous function space.
+
+This idea was started approximately in February 2005. 
+
+I want to appologize for the limited flexibility of the code at the moment. 
+That's why the use of this external is only recommended to developers.
+
+This code collection consists of four pd-objects:
+
+1. pdoctave: an object that calls octave and holds a pipe to its std in. this pipe can be acessed through the other pd-objects.
+
+2. pd-command: sending commands (strings) to the octave command line
+3. pd-send:    creating variables on the octave workspace
+4. pd-get:     calling back variables from the octave workspace
+
+In order to communicate with octave, there are two .cc files that are compiled in octave external language (mkoctfile)
+5. read_shared_mem.cc
+6. write_shared_mem.cc
+
+The variables use a common header format with access functions and definitions in
+7. pdoctave-dataframe.c/h
+8. pdoctave-datatype.h
+
+
+Franz Zotter 22.Feb 2006 
+(Feb 2005)
+