Locic 项目启动与配置教程

1. 项目目录结构及介绍

Locic 项目采用以下目录结构：

locic/
├── bin/                      # 存放编译后的可执行文件
├── build/                    # 构建目录，存放构建过程中产生的文件
├── docs/                     # 文档目录，存放项目文档
├── include/                  # 头文件目录
├── lib/                      # 库文件目录
├── scripts/                  # 脚本目录，存放构建和辅助脚本
├── src/                      # 源代码目录，存放项目的源代码文件
├── test/                     # 测试目录，存放测试相关文件
├── .gitignore                # 指定git应该忽略的文件和目录
├── CMakeLists.txt            # CMake构建文件
├── README.md                 # 项目说明文件
└── run.sh                    # 运行脚本来启动项目

• bin/：存放编译后的可执行文件。
• build/：CMake构建过程中产生的中间文件存放于此。
• docs/：存放项目相关的文档资料。
• include/：存放项目所需的头文件。
• lib/：存放项目所需的库文件。
• scripts/：存放用于项目构建或辅助工作的脚本文件。
• src/：源代码目录，包含项目的所有源代码文件。
• test/：存放测试代码和测试数据。
• .gitignore：定义了哪些文件和目录应该被git版本控制系统忽略。
• CMakeLists.txt：CMake构建系统的配置文件，用于配置编译过程。
• README.md：项目的基本说明文件，通常包含项目描述、安装指南、使用说明等。
• run.sh：项目启动脚本，用于简化项目启动过程。

2. 项目的启动文件介绍

项目的启动文件为 run.sh，该脚本位于项目根目录下。该脚本的主要作用是简化项目启动流程，它会调用CMake和make工具来编译源代码，并启动编译后的程序。

以下是 run.sh 脚本的内容：

#!/bin/bash

# 进入构建目录
cd build

# 使用CMake生成Makefile
cmake ..

# 使用make编译项目
make

# 运行编译后的程序
./bin/locic

用户需要确保 run.sh 脚本具有执行权限，可以通过以下命令来赋予执行权限：

chmod +x run.sh

然后，用户可以通过执行以下命令来启动项目：

./run.sh

3. 项目的配置文件介绍

Locic 项目的配置主要通过 CMakeLists.txt 文件来完成。这是一个CMake配置文件，用于定义项目的构建过程。

以下是 CMakeLists.txt 文件的主要部分：

cmake_minimum_required(VERSION 3.10)

# 设置项目名称和版本
project(Locic VERSION 1.0)

# 设置C++标准
set(CMAKE_CXX_STANDARD 11)

# 添加执行文件
add_executable(Locic src/main.cpp)

# 添加头文件目录
include_directories(include)

# 链接库文件
target_link_libraries(Locic libLocic)

在这个配置文件中：

• cmake_minimum_required(VERSION 3.10) 指定了需要的CMake最小版本。
• project(Locic VERSION 1.0) 定义了项目的名称和版本。
• set(CMAKE_CXX_STANDARD 11) 设置了使用的C++标准版本。
• add_executable(Locic src/main.cpp) 指定了一个可执行文件 Locic，它由源文件 src/main.cpp 编译而来。
• include_directories(include) 添加了头文件搜索目录。
• target_link_libraries(Locic libLocic) 将目标文件 Locic 与库文件 libLocic 链接起来。

用户可以根据自己的需求对 CMakeLists.txt 文件进行相应的修改，以满足不同的构建需求。