From 2c23a63729d6323de172f7e1e8c16ff7ce8bedc6 Mon Sep 17 00:00:00 2001 From: Bryan Jurish Date: Sun, 8 Sep 2002 00:15:23 +0000 Subject: This commit was generated by cvs2svn to compensate for changes in r116, which included commits to RCS files with non-trunk default branches. svn path=/trunk/; revision=117 --- externals/sprinkler/README.pod | 60 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 externals/sprinkler/README.pod (limited to 'externals/sprinkler/README.pod') diff --git a/externals/sprinkler/README.pod b/externals/sprinkler/README.pod new file mode 100644 index 00000000..172458e9 --- /dev/null +++ b/externals/sprinkler/README.pod @@ -0,0 +1,60 @@ +=pod + +README for pd external 'sprinkler' (formerly 'forward') + +=head1 DESCRIPTION + +'sprinkler' objects do dynamic control-message dissemination. + +Given a list as input, a 'sprinkler' object interprets the initial +list element as the name of a 'receive' object, and [send]s the +rest of the list to that object. + +=head1 INSTALLATION + +Issue the following commands to the shell: + + cd sprinkler-X.YY (or wherever you extracted the distribution) + ./configure + make + make install + +=head1 BUILD OPTIONS + +The 'configure' script supports the following options, among others: + +=over 4 + +=item * --enable-debug , --disable-debug + +Whether to enable verbose debugging messages. +Default=no. + +=item * --enable-forward , --disable-forward + +Whether to create [forward] objects as instances +of the [sprinkler] class (MAX-incompatible). +Default=no. + +=back + +=head1 ACKNOWLEDGEMENTS + +PD by Miller Puckette and others. + +Ideas, black magic, and other nuggets of information drawn +from code by Guenter Geiger, Larry Troxler, and iohannes m zmoeling. + +Thanks to Krzysztof Czaja for pointing out to me the existence of MAX "forward", +and to Miller Puckette for the name "sprinkler". + +=head1 KNOWN BUGS + +One of the acknowledgements used to be in this section. +Sorry, folks. + +Backwards-compatible version is incompatible with MAX. + +=head1 AUTHOR + +Bryan Jurish Emoocow@ling.uni-potsdam.deE -- cgit v1.2.1