EdgeTX 开源项目使用教程
1. 项目的目录结构及介绍
EdgeTX 项目的目录结构如下:
EdgeTX/
├── devcontainer/
├── github/
├── cmake/
├── companion/
├── radio/
├── tools/
├── clang-format/
├── gitattributes
├── gitignore
├── gitmodules
├── gitpod.yml
├── CMakeLists.txt
├── LICENSE
├── README.md
├── cmake.sh
├── fw.json
目录结构介绍:
- devcontainer/: 包含开发容器配置文件。
- github/: 包含 GitHub 相关的配置文件。
- cmake/: 包含 CMake 构建系统的配置文件。
- companion/: 包含 EdgeTX 的配套软件相关文件。
- radio/: 包含与无线电硬件相关的文件。
- tools/: 包含各种工具和脚本。
- clang-format/: 包含代码格式化配置文件。
- gitattributes: Git 属性配置文件。
- gitignore: Git 忽略文件配置。
- gitmodules: Git 子模块配置文件。
- gitpod.yml: Gitpod 配置文件。
- CMakeLists.txt: CMake 构建系统的主配置文件。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍和使用说明。
- cmake.sh: CMake 构建脚本。
- fw.json: 固件配置文件。
2. 项目的启动文件介绍
EdgeTX 项目的启动文件主要是 CMakeLists.txt
和 cmake.sh
。
CMakeLists.txt
CMakeLists.txt
是 CMake 构建系统的主配置文件,定义了项目的构建规则和依赖关系。它指定了项目的源文件、目标文件、库文件以及编译选项等。
cmake.sh
cmake.sh
是一个脚本文件,用于自动化 CMake 的构建过程。它通常包含以下步骤:
- 设置编译环境。
- 调用 CMake 生成构建文件。
- 编译项目。
3. 项目的配置文件介绍
EdgeTX 项目的配置文件主要包括 fw.json
和 gitmodules
。
fw.json
fw.json
是固件配置文件,用于定义固件的版本、依赖关系、编译选项等信息。它通常包含以下内容:
- version: 固件版本号。
- dependencies: 固件依赖的其他库或模块。
- build_options: 编译选项。
gitmodules
gitmodules
是 Git 子模块配置文件,用于管理项目中的子模块。它定义了子模块的 URL、路径和分支信息。
通过这些配置文件,开发者可以方便地管理和定制 EdgeTX 项目的构建和配置。