|
- /**
- @page the_standalone_blocks_sdk The standalone BLOCKS SDK
-
- The easiest way to get started developing BLOCKS applications is to use the @jucegithub{JUCE framework}, but if you would prefer not to use JUCE directly the standalone BLOCKS SDK can be obtained from the @blocksgithub{BLOCKS-SDK repository}.
-
- The most straightforward way to use the SDK is to compile the SDK source code into a static library.
- Then, in your BLOCKS application code, you can use the header files in the SDK to give you access to the BLOCKS classes and functions.
- Finally, when you want to compile your application, you must link against the static library to get all the BLOCKS functionality.
-
- @section standalone_building_library Building the SDK library
-
- The source code for the BLOCKS SDK library is contained within the @s_file{SDK} directory of the BLOCKS-SDK repository.
- Here you will find header files that you can include in your own projects and the @s_file{Build} subdirectory contains an Xcode project, a Visual Studio project and a Linux Makefile for compiling the SDK source code into a static library.
- Use the appropriate choice for your platform, select either the "Debug" or "Release" configuration, and build the project.
-
- For macOS this will produce @s_file{libBLOCKS-SDK.a} in either the @s_file{SDK/Build/MacOS/Debug/} or @s_file{SDK/Build/MacOS/Release/} directory, for Linux this will produce @s_file{libBLOCKS-SDK.a} in either the @s_file{SDK/Build/Linux/Debug/} or @s_file{SDK/Build/Linux/Release/} directory, and for Windows this will produce @s_file{BLOCKS-SDK.lib} in either the @s_file{SDK\\Build\\Windows\\x64\\Debug} or @s_file{SDK\\Build\\Windows\\x64\\Release} folder.
-
- @section standalone_using_header Using the SDK header file
-
- To use BLOCKS classes and functions in your application you must include the @s_file{BlocksHeader.h} file in your source code.
- You also need to tell the compiler to look in the @s_file{SDK} directory for additional header files, which you can configure inside your Xcode or Visual Studio project.
- If you are using the command line to compile your application then you can see an example of how to do this in @s_file{examples/BlockFinder/Linux/Makefile} or @s_file{examples/BlockFinder/MacOS/Makefile}.
-
- @section standalone_linking Linking against the SDK library
-
- You must also tell your compiler where to find the SDK static library before your BLOCKS application will compile, and include all of the dependencies for your platform, which are listed in the @ref standalone_dependencies section.
- Again, this is configured in your Xcode or Visual Studio project, but if you are using the command line you can see an example of how to do this in @s_file{examples/BlockFinder/Linux/Makefile} or @s_file{examples/BlockFinder/MacOS/Makefile}.
-
- You can find example code of how to integrate the BLOCKS SDK into existing applications in the @ref example_integrations section.
-
- @section standalone_dependencies Standalone SDK dependencies
-
- - A C++11 compatible compiler
-
- @subsection standalone_libraries_macos macOS frameworks
-
- - Accelerate
- - AudioToolbox
- - CoreAudio
- - CoreMIDI
-
- @subsection standalone_libraries_linux Linux packages
-
- - x11
- - alsa
- - libcurl
- */
|
