BespokeSynth 项目教程

1. 项目目录结构及介绍

BespokeSynth 项目的目录结构如下：

BespokeSynth/
├── autodoc/
├── bespoke_windows_installer/
├── libs/
├── resource/
├── scripts/
├── .clang-format
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .gitmodules
├── CHANGELOG.md
├── CMakeLists.txt
├── LICENSE
├── README.md
├── add-file-headers.py
├── azure-pipelines.yml
├── bespoke_icon.png
├── bespoke_quick_reference.png
├── bespoke_script_autodoc.py
├── header_file.txt
├── screenshot-1.png

目录介绍

• autodoc/: 自动文档生成相关文件。
• bespoke_windows_installer/: Windows 安装程序相关文件。
• libs/: 项目依赖的库文件。
• resource/: 项目资源文件，如图片、样式表等。
• scripts/: 项目脚本文件，用于自动化任务。
• .clang-format: Clang 格式化配置文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置文件。
• CHANGELOG.md: 项目更新日志。
• CMakeLists.txt: CMake 构建配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• add-file-headers.py: 添加文件头部的脚本。
• azure-pipelines.yml: Azure Pipelines 配置文件。
• bespoke_icon.png: BespokeSynth 图标文件。
• bespoke_quick_reference.png: 快速参考图片。
• bespoke_script_autodoc.py: 自动生成文档的脚本。
• header_file.txt: 文件头部模板。
• screenshot-1.png: 项目截图。

2. 项目启动文件介绍

BespokeSynth 项目的启动文件是通过 CMake 构建生成的可执行文件。具体步骤如下：

1. 克隆项目:

   git clone https://github.com/BespokeSynth/BespokeSynth.git
   cd BespokeSynth
   

2. 初始化子模块:

   git submodule update --init --recursive
   

3. 配置和构建项目:

   cmake -Bignore/build -DCMAKE_BUILD_TYPE=Release
   cmake --build ignore/build --parallel 4 --config Release
   

4. 运行可执行文件: 构建完成后，生成的可执行文件位于 ignore/build/Source/BespokeSynth_artefacts 目录下。

3. 项目的配置文件介绍

BespokeSynth 项目的主要配置文件是 CMakeLists.txt，它定义了项目的构建过程和依赖关系。以下是一些关键配置项：

• CMAKE_BUILD_TYPE: 指定构建类型，如 Release 或 Debug。
• BESPOKE_VST2_SDK_LOCATION: 指定 VST2 SDK 的路径，用于支持 VST2 插件。
• BESPOKE_ASIO_SDK_LOCATION: 指定 ASIO SDK 的路径，用于支持 ASIO 音频驱动。
• BESPOKE_SPACEMOUSE_SDK_LOCATION: 指定 SpaceMouse SDK 的路径，用于支持 SpaceMouse 导航。
• BESPOKE_PYTHON_ROOT: 指定 Python 根目录，用于 Python 集成。
• CMAKE_INSTALL_PREFIX: 指定安装路径，仅在 Linux 上使用。

通过这些配置项，用户可以根据自己的需求定制 BespokeSynth 的构建过程。