build.txt (2242B)
1 Appendix B: Building ZynAddSubFX 2 -------------------------------- 3 4 Introduction to CMake 5 ~~~~~~~~~~~~~~~~~~~~~ 6 7 ******************************************************************** 8 Note: This section was mostly copied from the OpenSceneGraph wiki, at: 9 http://www.openscenegraph.org/projects/osg/wiki/Build/CMake 10 ******************************************************************** 11 12 ZynAddSubFX uses CMake as its unified build system. CMake 13 is able to read simple build scripts from the source tree and create 14 from this a platform-specific build system. This build system can be in 15 the form of VisualStudio project files, Unix Makefiles or XCode project 16 files. CMake is able to automatically locate external dependencies, and 17 allows you to toggle on/off module compilation and configure various 18 build options. 19 20 The use of a unified build system has allowed to avoid build breakages 21 that were common in the previous build method of maintaining three 22 separate build targets for VisualStudio, Unix "make" and XCode. It also 23 reduces the maintenance burden for core developers and contributors. 24 Taken together usage of CMake should result in better consistency and 25 more stable builds across all platforms for end users and a greater 26 productivity in development of new versions. Hopefully with greater 27 consistency of builds across platforms it will be easier for developers 28 to use the development version of ZynAddSubFX and help contribute 29 to its testing and refinement, leading to a high-quality code base. 30 31 Quick start guide 32 ~~~~~~~~~~~~~~~~~ 33 34 For the impatient ones, here is a quick guide on how to immediately 35 build ZynAddSubFX from source. 36 37 ************************************************************** 38 Note: This assumes that you already have a copy of the source. 39 ************************************************************** 40 41 --------------------------------- 42 #enter the source directory 43 cd zynaddsubfx 44 45 #make a directory for an out-of-source build 46 mkdir build 47 cd build 48 49 #generate a cmake build project here from the cmake root, which is 50 #found in the directory below the current one 51 cmake .. 52 53 #OPTIONAL: Adjust compile variables in the Cache file: 54 ccmake . 55 56 #And finally, build as usual using make 57 make 58 --------------------------------- 59