search

ideoforms / signalflow

A sound synthesis framework for Python, designed for clear and concise expression of complex musical ideas
https://signalflow.dev
MIT License
167 stars 14 forks source link

Documentation: Add "build from source" section #114

Open shakfu opened 4 months ago

shakfu commented 4 months ago

May I suggest that the docs make explicit the prerequisites to build signal flow such as soundio and libsndfile, which in my case on macOS required brew install libsoundio libsndfile.

The current documents don't mention these (at least I coundn't find any mention), and these are only apparent If one tries to build via python3 setup.py build, or by looking into the CMakeLists.txt file.

After installing the above two libs, I was able to build signalflow via python3 setup.py build, but there was a warning about not finding vamp:

CMake Warning at CMakeLists.txt:201 (message):
  Couldn't find vamp

Is this optional? How does one install vamp for example?

ideoforms commented 4 months ago

Thanks @shakfu. This is documented in "Building from source" in CONTRIBUTING.md, but I appreciate that this isn't very well signposted... I'll add an explicit section in the online docs for this.

vamp is an optional dependency, hence being a warning not a fatal. If you install vamp-plugins (which can be done using homebrew on macOS), it should detect and compile with vamp support automatically. Be warned that vamp support is not yet very mature or documented.

shakfu commented 4 months ago

Thanks!