Dictu 项目启动与配置教程

1. 项目目录结构及介绍

Dictu 是一个开源的高级别动态类型、多范式、解释型编程语言项目。以下是项目的目录结构及其介绍：

Dictu/
├── .devcontainer/         # 开发环境配置
├── .github/               # GitHub 工作流和配置
├── Docker/                # Docker 配置和镜像
├── docs/                  # 项目文档
├── examples/              # 示例程序
├── ops/                   # 运维相关脚本和文件
├── src/                   # Dictu 编译器和运行时的源代码
├── tests/                 # 测试代码和测试用例
├── .clang-format          # Clang 格式配置文件
├── .dockerignore          # Docker 忽略文件
├── .gitignore             # Git 忽略文件
├── CMakeLists.txt         # CMake 构建配置文件
├── CMakePresets.json      # CMake 预设构建配置
├── CODE_OF_CONDUCT.md     # 项目行为准则
├── LICENSE                # 项目许可证
├── README.md              # 项目自述文件
├── vcpkg.json             # VCPKG 包管理器配置

• .devcontainer/: 包含开发容器配置，用于在容器化环境中进行开发。
• .github/: 包含 GitHub Actions 工作流和配置，用于自动化项目管理任务。
• Docker/: 包含 Dockerfile 和其他 Docker 相关配置文件。
• docs/: 存放项目文档的目录。
• examples/: 包含使用 Dictu 语言编写的示例程序。
• ops/: 包含运维相关的脚本和文件。
• src/: 包含 Dictu 编译器和运行时的源代码。
• tests/: 包含测试代码和测试用例，用于验证项目的功能。
• .clang-format: Clang 格式配置文件，用于统一代码风格。
• .dockerignore: 指定在构建 Docker 镜像时应该忽略的文件和目录。
• .gitignore: 指定在 Git 版本控制中应该忽略的文件和目录。
• CMakeLists.txt: CMake 构建配置文件，用于构建项目。
• CMakePresets.json: CMake 预设构建配置文件，提供了一套预设的构建选项。
• CODE_OF_CONDUCT.md: 项目行为准则，指导参与者如何行为。
• LICENSE: 项目许可证文件，本项目采用 MIT 许可。
• README.md: 项目自述文件，介绍项目的基本信息和如何使用。
• vcpkg.json: VCPKG 包管理器配置文件。

2. 项目的启动文件介绍

Dictu 项目的启动主要是通过 CMake 来进行的。以下是主要的启动文件：

• CMakeLists.txt: 这是主要的 CMake 构建文件，用于定义项目的构建过程和依赖。
• CMakePresets.json: 提供了预设的 CMake 构建选项，可以简化构建配置。

要启动项目，你需要在项目根目录下执行以下命令：

mkdir build && cd build
cmake ..
make
./dictu

对于 Windows 用户，可能需要添加 --config Release 来获取 Release 构建版本。

3. 项目的配置文件介绍

Dictu 项目的配置主要是通过 CMake 配置文件进行的。以下是主要的配置文件：

• CMakeLists.txt: 在这个文件中，你可以定义项目的构建选项，比如构建类型（Debug 或 Release），是否启用某些功能（例如 HTTP 类），以及指定外部依赖等。
• CMakePresets.json: 在这个文件中，可以预设多个构建配置，例如不同的编译器选项、构建类型等。

在 CMakeLists.txt 文件中，你可以找到如下配置选项：

• -DCMAKE_BUILD_TYPE=Release: 指定构建类型为 Release。
• -DDISABLE_HTTP=1: 如果不希望包含 HTTP 类，可以设置此选项。
• -DENABLE_VCPKG=1: 如果使用 VCPKG 包管理器，可以设置此选项。

通过修改这些配置，可以调整项目的构建行为以满足不同的需求。