You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,24 @@ Also, with CMake you have a choice of which build system you use.
33
33
34
34
- The default on macOS and Linux is `Unix Makefiles`. On macOS you can also use Xcode by passing `-GXcode` to CMake when you first run it.
35
35
- The default on Windows is the latest version of Visual Studio installed. However, Visual Studio can open CMake files directly as projects, which has some upsides. When used this way, CMake variables have to be set via a JSON file that MSVC will use to configure CMake.
36
+
## The `DOCS` option
37
+
The CMake option `DOCS` controls whether or not to generate the documentation for the FluCoMa objects. It is on by default. However, building the documentation is slightly involved and requires that you have a working Python 3 installation, among other things (see https://github.com/flucoma/flucoma-docs).
38
+
39
+
If you just want some binaries, it could be simpler to disable this and just take some documentation from a release download:
40
+
41
+
```bash
42
+
mkdir -p build &&cd build
43
+
cmake -DSC_PATH=</path/to/sc> -DDOCS=OFF ..
44
+
make install
45
+
```
46
+
47
+
48
+
49
+
50
+
51
+
52
+
53
+
36
54
37
55
## Using Manual Dependencies
38
56
@@ -51,16 +69,17 @@ cmake -DSC_PATH=<location of your SC source> -DFLUID_PATH=<location of Fluid Cor
51
69
52
70
To find out which branches / tags / commits of these we use, look in the top level `CMakeLists.txt` of the Fluid Corpus Manipulation Library for the `FetchContent_Declare` statements for each dependency.
53
71
72
+
54
73
## Compiling for different CPUs
55
74
56
-
The build system generally assumes an x86 cpu with AVX instructions (most modern x86 CPUs). To build on another kind of CPU (e.g. older than 2012) you can use the `FLUID_ARCH` cache variable to pass specific flags to your compiler. For example use `-DFLUID_ARCH=-mcpu=native` to optimize for your particular CPU.
75
+
The build system generally assumes an x86/x64 cpu with SSE instructions or Apple Silicon. To build on another kind of CPU (e.g. older than 2012) you can use the `FLUID_ARCH` cache variable to pass specific flags to your compiler. For example use `-DFLUID_ARCH=-mcpu=native` to optimize for your particular CPU.
57
76
58
77
For ARM, we use the following default set of flags (with the Bela in mind):
0 commit comments