Project Prerequisites

Before you can build and run this project, you need to ensure that you have the following dependencies installed on your system:

• CMake2: This project uses CMake as its build system. You can download it from the official website. Make sure to add CMake to your system PATH after installation.
• Python: This project uses Python for some of its scripts. You can download Python from the official website. Make sure to add Python to your system PATH after installation.
  • Jinja23: This is a Python library used in this project. After installing Python, you can install Jinja2 by running pip install jinja2 in your terminal.
• C++20: This project is written in C++20. Therefore, you need a C++ compiler that supports C++20. It is recommended to use GCC version 10 or later, Clang version 10 or later, or MSVC version 19.28 (Visual Studio 2019 16.8) or later.

Please ensure that all these prerequisites are met before proceeding with the build process. If you encounter any issues, feel free to open an issue on GitHub.

The project is cross-platform, but due to limited resources, it is currently only configured for the Windows platform (supports compilation with Visual Studio 2022 or using VSCode). You can visit the project's GitHub repository through this link: https://github.com/yangyunzhao/toy.

Additionally, the project integrates the following tools and libraries to optimize the development process:

• Doxygen: For generating project documentation. For more information and download, please visit Doxygen's official website.
• Graphviz: For generating graphical content in documentation. For details and download information, please check Graphviz's official website.
• Clang-Format: For unifying code style. For more details, please visit Clang-Format's official documentation.
• Catch2 v2: For unit testing. You can get it from the official Catch2 v2 GitHub repository.

Before starting the build process, make sure all these prerequisites are satisfied. If you have any problems during the process, you are welcome to open an issue on GitHub.

项目前置条件

在您构建和运行此项目之前，需要确保您的系统已安装以下依赖项：

• CMake：本项目使用 CMake 作为构建系统。您可以从官方网站下载。安装后，请确保将 CMake 添加到您的系统 PATH 中。
• Python：本项目使用 Python 执行一些脚本。您可以从官方网站下载 Python。安装后，请确保将 Python 添加到您的系统 PATH 中。
  • Jinja2：这是项目中使用的 Python 库。安装 Python 后，您可以通过在终端运行 pip install jinja2 来安装 Jinja2。
• C++203：本项目使用 C++20 编写。因此，您需要支持 C++20 的 C++ 编译器。推荐使用 GCC 10 或更高版本、Clang 10 或更高版本、MSVC 19.28（Visual Studio 2019 16.8）或更高版本。

请在继续构建过程之前确保满足所有这些前置条件。如果您遇到任何问题，请在 GitHub 上提出 issue。

本项目是跨平台的，但由于时间有限，目前仅配置了 Windows 平台（支持 Visual Studio 2022 编译或者使用 VSCode）。您可以通过以下链接访问项目的 GitHub 仓库：https://github.com/yangyunzhao/toy。

此外，项目还整合了以下工具和库以优化开发流程：

• Doxygen：用于生成项目文档。了解更多信息和下载，请访问Doxygen 官方网站。
• Graphviz：用于生成图形化的文档内容。详情和下载信息，请查看Graphviz 官方网站。
• Clang-Format：用于统一代码风格。更多详情，请访问Clang-Format 官方文档。
• Catch2 v2：用于单元测试。您可以从Catch2 v2 官方GitHub仓库获取。

在开始构建过程之前，请确保所有这些前置条件都已满足。如果您在过程中遇到任何问题，欢迎在 GitHub 上开启一个 issue。