Bug fixed for unix error "readlink /proc/self/fd/0" on MacOS.
[Faustine.git] / interpreter / preprocessor / faust-0.9.47mr3 / architecture / osclib / readme.txt
1 ======================================================================
2 FAUST OSC Library
3 ======================================================================
4
5 ----------------------------------------------------------------------
6 Compiling the library
7 ----------------------------------------------------------------------
8
9 The Faust OSC library project depends on the oscpack library, which
10 is included in this distribution. You should first compile the oscpack
11 library before compiling the FAUST OSC library. Both libraries rely
12 on CMake, a cross-platform, open-source build system
13 (see at http://www.cmake.org).
14
15 1) Compiling oscpack
16 -----------------------------------
17 To compile:
18 change to oscpack/cmake directory
19 type: cmake -G "your target generator"
20 run your project/makefile and compile
21
22 Typically on linux systems:
23 > cd oscpack/cmake
24 > cmake -G "Unix Makefiles"
25 > make
26
27 The compiler output is a static library named liboscpack.a and placed
28 in the 'osclib' folder. Note that when 'Release' and 'Debug' targets
29 apply, only the 'Release' output goes to the 'osclib' folder.
30
31
32 2) Compiling the FAUST OSC library
33 -----------------------------------
34 To compile:
35 change to faust/cmake directory
36 type: cmake -G "your target generator"
37 run your project/makefile and compile
38
39 Typically on linux systems:
40 > cd faust/cmake
41 > cmake -G "Unix Makefiles"
42 > make
43
44 The compiler output is a static library named libOSCFaust.a and placed
45 in the 'osclib' folder. Note that when 'Release' and 'Debug' targets
46 apply, only the 'Release' output goes to the 'osclib' folder.
47
48
49 ----------------------------------------------------------------------
50 Using the library
51 ----------------------------------------------------------------------
52 The library provides a single interface file: OSCControler.h
53 The following options should be used to compile:
54 -Iosclib/faust/include -Losclib -loscpack -lOSCFaust
55 See the faust/readme.txt file for more details about the library.
56
57
58 ----------------------------------------------------------------------
59 Examples
60 ----------------------------------------------------------------------
61 The FAUST OSC architecture should be typically combined with other
62 architectures. The file 'OSCUI.h' provides the basis for such combination
63 and the file 'jack-console-osc.cpp' provides an example of combination.
64
65 ======================================================================
66 In case of trouble, contact me: <fober@grame.fr>
67 ----------------------------------------------------------------------
68 Copyright 2011 (c) Grame