一个足够 简单易用 并且 可配置的用于构建 C/C++
的模板工程
使用
CMake
构建,并且支持带GUI
配置界面的Kconfig
基于此工程,可以快速搭建你的项目构建系统,减少许多不必要的麻烦~
希望能帮到你,如果帮到了请右上角给颗小星星哦 ~~ 如果有啥不足欢迎提 issue。 (´ε` ʃƪ)♡
本项目的目标人群:
- 正准备写
SDK
并且需要自己写构建系统的开发者 - 正准备开始编写一个需要写构建系统的开发者
- 对
CMake
不太了解,但想学习CMake
的开发者 - 想重构代码工程构建系统的,比如因为之前写的构建系统太杂乱
- 想给构建系统中加一个十分好用的配置系统,可以按需求快速增删代码模块的,而且最好带界面配置的 开发者
- 想让项目可以生成多种
IDE
支持的工程
cd examples/demo1
# python project.py --toolchain /opt/toolchain/bin --toolchain-prefix mips-elf- config
mkdir build && cd build
cmake ..
make menuconfig
make -j10
./build/demo1
make clean
rm -rf ./*
or
cd examples/demo1
# python project.py --toolchain /opt/toolchain/bin --toolchain-prefix mips-elf- config
python project.py menuconfig
python project.py build
./build/demo1
python project.py clean
python project.py distclean
# python project.py clean_conf
- 切换工程目录
- 设置工具链路径以及前缀(如果使用
gcc
不需要设置) - 建立一个临时目录并且切换当前路径到这个临时目录(
build
) - 使用命令
cmake ..
来生成Makefile
, 这里..
表示上层目录,即项目的目录 - 使用命令
make menuconfig
来通过终端图形界面配置工程, 这会在build/config
目录生成几个配置文件(global_config.*
), 我们可以直接在组件(component
)的CMakelists.txt
文件中直接使用(详细看后面的说明), 或者在C/CPP
源文件中通过语句#include "global_config.h"
包含配置头文件来使用 - 使用命令
make
来执行编译链接过程, 或者并行编译: make -jN, 以及通过make VERBOSE=1
命令来打印编译时的调试信息
可以点击 use this template
按钮来使用这个模板创建一个你自己的 github
工程
目录/文件 | 功能 |
---|---|
根目录 | 本项目的根目录,也是 SDK 项目的 SDK 目录 |
assets | 存放多媒体资源的文件夹,比如图片等,如果不需要可以删除 |
components | 组件(component)都放在这里 |
examples | 工程目录,或者例程目录;在 SDK 项目中这个目录是可以和 SDK 目录分开放的, 只需要设置环境变量MY_SDK_PATH 为SDK 目录路径即可 |
tools | 工具目录比如 cmake 、kconfig 、burn tool etc. |
Kconfig | Kconfig 的最顶层配置 |
所有库均作为组件(component)被放在components
目录下或者工程目录下,每个组件用一个目录,这个目录就是这个组件的名字, 为了使工程看起来更简洁,不对组件进行嵌套,所有组件都是一个层级,组件之间的关系依靠依赖关系(requirements)来维持
所有源文件都必须在某个组件内,每个工程必须包含一个叫 main
的组件(即examples/demo1/main
目录),每个组件包含文件如下:
-
CMakeLists.txt
: 必须有,声明组件源文件以及依赖的组件,并且调用注册函数注册自己,详细可以参考components/component1
和components/component2
下CMakeLists.txt
的写法 -
Kconfig
: 可选,包含了本组件的配置选项, 在本组件或者其它依赖了本组件的组件的CMakeLists.txt
中都可以在加一个CONFIG_
前缀后使用这些配置项,比如在components/component2
中,Kconfig
中有COMPONENT2_ENABLED
选项,我们在它的CMakeLists.txt
中就使用了这个变量if(CONFIG_COMPONENT2_ENABLED)
来判断如果用户配置不用这个组件就不注册这个组件
工程目录在examples
目录下,当然,这个目录的名字是可以随意根据实际需求修改的,下面可以包含多个实际的工程目录,需要编译那个工程时切换到对应的目录就可以编译。上面也说了,每个工程目录下必须有一个 main
组件, 当然也可以放很多自定义的组件。 可以参考examples/demo1
工程目录。
工程目录下文件:
-
CMakeLists.txt
: 工程属性文件,必须先包含include(${SDK_PATH}/tools/cmake/compile.cmake)
,然后用project
函数声明工程名称,比如project(demo1)
,当然还可以编写其它的条件或者变量等,使用CMake
语法, 参考examples/demo1/CMakeLists.txt
的写法 -
config_defaults.mk
: 工程默认配置文件,执行cmake
构建时会从这里加载默认配置,配置的格式是Makefile
的格式,可以先使用终端界面配置(make menuconfig
)生成配置文件复制过来,生成的配置文件在build/config/global_config.mk
。
注意:每次修改
config_defaults.mk
后需要删除build
目录下的文件(或者只删除build/config/global_config.mk
文件)重新生成,因为当前构建系统会优先使用build
目录下已经存在的配置文件
- ESP_IDF:
ESP32
的SDK
, 写得挺不错 - Kconfiglib:
Kconfig
Python
实现 - RT-Thread:不是用的
CMake
, 但是也是使用了组件的概念