BuildingSimple

Compiling the FAUST project: the simple way.

Compilation and Installation

Since release 2.5.18, Faust compilation and installation is based on cmake. For details about compilation, you should look at the build/README.md file.

Getting the source code

In order to compile Faust on your machine you can either download the latest release of the source code https://github.com/grame-cncm/faust/releases or clone the git repository. In order to clone the git repository you will have to do the following steps:

git clone https://github.com/grame-cncm/faust.git
cd faust
git submodule update --init

The last step git submodule update --init is a new one. This is due to the fact that the Faust libraries have been moved to an independent github repository. This repository is a submodule of the Faust repository (as well as some other Faust related projects).

Linux and MacOSX

To build Faust on MacOSX or Linux, just run the following commands from the root of the distribution:

make
sudo make install

This will compile the Faust compiler only, with a set of backends that do not have additional dependencies (so the LLVM backend will not be compiled). Use make help to see what other targets can be used from the toplevel Makefile.

To refine compilation for more specific cases, go to the build folder and see the build/README.md file.

Windows

Using the MSYS2 environment, building steps on Windows are similar to Linux and MacOSX:

make
sudo make install

For other environments or options, go to the build folder and see the build/README.md file.

---