The Turing Way 项目使用教程

1. 项目目录结构及介绍

The Turing Way 项目的目录结构如下所示：

the-turing-way/
├── .github/
├── README-translated/
├── book/
├── tests/
├── .all-contributorsrc
├── .gitignore
├── .yamllint
├── .zenodo.json
├── ACCESSIBILITY.md
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── GOVERNANCE_ROLES.md
├── LICENSE.md
├── README.md
├── Vagrantfile
├── contributors.md
├── lychee.toml
├── netlify.toml
├── release-workflow.md
└── ways_of_working.md

• .github/: 存放 GitHub 的一些配置文件。
• README-translated/: 包含项目 README 文件的翻译版本。
• book/: 包含 The Turing Way 书籍的源文件。
• tests/: 包含项目的测试代码。
• .all-contributorsrc: 定义所有贡献者的信息。
• .gitignore: 指定 Git 忽略的文件和目录。
• .yamllint: 用于校验 YAML 文件的格式。
• .zenodo.json: Zenodo 存储库的配置文件。
• ACCESSIBILITY.md: 项目的可访问性说明。
• CITATION.cff: 用于引用 The Turing Way 的 CITATION 文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 提供如何为项目做贡献的指南。
• GOVERNANCE_ROLES.md: 定义项目治理角色的文档。
• LICENSE.md: 项目的许可证信息。
• README.md: 项目的主 README 文件。
• Vagrantfile: 用于创建虚拟环境的 Vagrant 配置文件。
• contributors.md: 记录项目贡献者的文件。
• lychee.toml: Lychee 的配置文件。
• netlify.toml: Netlify 的配置文件。
• release-workflow.md: 定义项目发布工作流的文档。
• ways_of_working.md: 描述项目工作方式的文档。

2. 项目的启动文件介绍

项目的启动主要是通过阅读 README.md 文件来了解如何使用和贡献到 The Turing Way 项目。该文件包含以下内容：

• 项目简介：介绍 The Turing Way 是什么，以及它的目标和用途。
• 使用指南：提供如何阅读和使用在线书籍的指导。
• 贡献指南：说明如何为项目做贡献，包括如何编写新章节、维护现有章节、共享资源等。
• 联系方式：提供与项目团队联系的方法。

3. 项目的配置文件介绍

项目中的配置文件主要包括 .gitignore、.yamllint、lychee.toml 和 netlify.toml。

• .gitignore: 此文件用于配置 Git 忽略的文件和目录，例如编辑器产生的临时文件、构建产生的文件等。
• .yamllint: 用于配置 YAML 文件的校验规则，确保项目中的 YAML 文件格式正确。
• lychee.toml: Lychee 是一个配置管理工具，该文件用于配置 Lychee 的相关参数。
• netlify.toml: 用于配置 Netlify 的部署设置，例如构建命令、发布目录等。

这些配置文件帮助维护项目的结构和质量，确保项目可以顺利地进行开发、测试和部署。