[CMake教程] 最简单的CMakeLists.txt — CMake Hello World

我们平时编译程序时，所使用的各种IDE已经帮你规划好编译流程，但这样编译可控性不好，有时不能按照自己的意愿编译，并且有些IDE不能跨平台，需要重新建工程，很不方便。而CMake可以解决以上问题，特别是在Linux上使用更加方便。
接下来是CMake最简单的也是基本的使用流程：

一、编写源文件

// hello.c
#include <stdio.h>

int main()
{
    printf("hello CMake!\n");
    return 0;
}

二、编写CMakeLists.txt

这里CMakeLists.txt与hello.c在同一目录。
文件目录结构为：

.
├── CMakeLists.txt
└── hello.c

CMakeLists.txt 内容：

# CMakeLists.txt
cmake_minimum_required(VERSION 3.5)
project(test_1)
add_executable(test_1 hello.c) 

其中，涉及到三个CMake 语句，解释如下：

cmake_minimum_required(VERSION 3.5) ：设置CMake最低版本要求，低于该版本将停止编译并报错，该语句应位于CMakeLists.txt第一行，以确保在编译之前可以使用特定的最小CMake功能集。

cmake_minimum_required() 的命令原型如下：

cmake_minimum_required(VERSION major.minor[.patch[.tweak]])

VERSION关键字必须存在，并且提供的版本详细信息必须至少包含major(主版本号)和minor(次版本号)。在大多数项目中，没有必要指定patch(补丁)和tweak(调整)部分，因为新功能通常只出现在minor更新中(这是从3.0版开始的官方CMake行为)。

project(test_1)：设置项目名称。

project() 的命令原型如下：

project(projectName
    [VERSION major[.minor[.patch[.tweak]]]]
    [LANGUAGES languageName ...]
)

projectName 是必需的，并且只能包含字母、数字、下划线(_)和连字符(-)，仅用于标识项目名称，无其他意义。

VERSION 可选，仅CMake 3.0及更高版本支持该选项，仅用于标识项目版本号，无其他意义。

LANGUAGES 可选，仅CMake 3.0及更高版本支持该选项，定义项目编程语言，官方建议启用。支持的值包括C、CXX、Fortran、ASM、Java等，多种语言用空格分隔。如果没有提供该选项，CMake将默认为C和CXX。官方鼓励新项目指定至少3.0的CMake版本，并使用带有LANGUAGES关键字的选项，如下：

project(test_1 LANGUAGES C CXX)

CMake 3.0以下版本使用如下命令指定语言（3.0以上的CMake也支持该语法）：

project(test_1 C CXX)

add_executable(test_1 hello.c)： 生成可执行文件，test_1是可执行文件的名字，hello.c是源文件名称，如有其他源文件，可在后面添加。

add_executable() 的命令原型如下：

add_executable(targetName source1 [source2 ...])

通过使用不同的目标名称多次调用add_executable()，可以在一个CMakeLists.txt文件中生成多个可执行文件。但如果在多个add_executable()命令中使用相同的目标名称，CMake将停止编译并报错。

注意：

CMake命令不区分大小写，但参数区分大小写。

如下语句均合法：

project(test_1 LANGUAGES C CXX)
Project(test_1 LANGUAGES C CXX)
PROJECT(TEST_1 LANGUAGES C CXX)

如下语句不合法：

project(test_1 languages C CXX)
project(test_1 LANGUAGES c CXX)

三、执行cmake, 得到Makefile

语法为

cmake [path]

path 为 CMakeLists.txt 的路径，这里是在CMakeLists.txt所在目录打开的terminal，所以命令为：

cmake .

执行过后输出如下log，表示成功：

一级文件目录结构为：

.
├── CMakeCache.txt
├── CMakeFiles
├── cmake_install.cmake
├── CMakeLists.txt
├── hello.c
└── Makefile

这里可以看到生成的文件和源文件在一起了，如果有好多源文件，会显得很乱，所以建议执行cmake前，先创建build文件夹，在此文件夹内执行cmake ..(因为CMakeLists.txt在上级目录，所以后面是两个点)
目录结构为：

.
├── build
│   ├── CMakeCache.txt
│   ├── CMakeFiles
│   ├── cmake_install.cmake
│   └── Makefile
├── CMakeLists.txt
└── hello.c

更进一步，上述目录结构仍然不规范，对于小型项目并无大碍，但对于大型项目，一般将源码与CMakeLists.txt单独置于和build同级的src目录下：

.
├── build
│   ├── CMakeCache.txt
│   ├── CMakeFiles
│   ├── cmake_install.cmake
│   └── Makefile
└── src
    ├── CMakeLists.txt
    └── hello.c

四、编译

这里可以使用make 或 cmake --build . 命令进行编译：

其中，cmake --build .命令可以跨平台构建项目，而make命令则只适用于Linux和Unix平台。

注意要在第三步生成的 Makefile 的目录下执行这一命令。
输出log为：

出现 [100%] Built target test_1 就是编译成功了，可以看到多出了一个 test_1 可执行文件。
执行该文件：

./test_1

输出如下：