Skip to content

Commit

Permalink
Update to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
malloch committed Feb 21, 2018
1 parent 1293d71 commit 6062d21
Showing 1 changed file with 11 additions and 23 deletions.
34 changes: 11 additions & 23 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,35 +1,23 @@
libmapper bindings for MaxMSP and Pure Data
===========================================
# libmapper bindings for MaxMSP and Pure Data

MAXMSP and PureData objects instantiating libmapper devices. Help patches for MaxMSP and
PureData are included for documentation.
Max and Pure Data (Pd) objects instantiating libmapper devices. Help patches are included for documentation.

The `mapper` object can be used with both MaxMSP and Pure Data - it encapsulates the
functionality of a libmapper device and works as a central hub in your patch by sending
and receiving labeled messages from the libmapper network.
The `mapper` object can be used with both Max and Pd - it encapsulates the functionality of a libmapper device and works as a central hub in your patch by sending and receiving labeled messages from the libmapper network.

For MaxMSP there are now another set of bindings which attempt to provide a more max-like
interface to the libmapper ecosystem. The `map.device` object creates a libmapper device
as before, but it communicates with an arbitrary number of `map.in` and `map.out` objects
in your patch (and subpatchers) which can be used essentially as networked replacements
for the internal `inlet` and `outlet` objects. Please load the help patches for more
documentation and examples of use.
For MaxMSP there are now another set of bindings which attempt to provide a more Max-like interface to the libmapper ecosystem. The `map.device` object creates a libmapper device as before, but it communicates with an arbitrary number of `map.in` and `map.out` objects in your patch (and subpatchers) which can be used essentially as networked replacements
for the internal `inlet` and `outlet` objects. Please load the help patches for more documentation and examples of use.

Hopefully in the near future the new bindings will also be adapted for Pure Data - for
now Pd users are stuck with the (fully-functional) `mapper` object.
Hopefully in the near future the new bindings will also be adapted for Pure Data - for now Pd users are stuck with the (fully-functional) `mapper` object.

This software is licensed under the GNU Lesser Public General License version 2.1 or
later; see the attached file COPYING for details, which should be included in this
download.
This software is licensed under the GNU Lesser Public General License version 2.1 or later; see the attached file COPYING for details, which should be included in this download.

To build, you will first need to install [libmapper][1] and [liblo][2] from their
respective repositories. An installation of liblo <= v0.26 is not sufficient, as
libmapper depends on new functionality in the library.
To build, you will first need to install [libmapper][1] and [liblo][2] from their respective repositories. An installation of liblo <= v0.26 is not sufficient, as libmapper depends on new functionality in the library.

On OSX you can build all the binaries by running the script `package-osx.sh` from the command-line.

Joseph Malloch 2011
[Input Devices and Music Interaction Laboratory][3], McGill University.
## Acknowledgements

Development of this software was mainly supported by the [Input Devices and Music Interaction Laboratory][3] at McGill University.

[1]: http://github.com/libmapper/libmapper
[2]: http://github.com/radarsat1/liblo
Expand Down

0 comments on commit 6062d21

Please sign in to comment.