Rust Sokoban 项目教程

Rust Sokoban 项目教程

rust-sokoban Rust Sokoban book and code samples 项目地址: https://gitcode.com/gh_mirrors/ru/rust-sokoban

1. 项目目录结构及介绍

rust-sokoban 项目是一个使用 Rust 语言编写的推箱子游戏的教程和示例代码。项目的目录结构如下：

• books: 包含 mdbook 组织的教程文档。
• code: 包含每个教程章节对应的 Rust 代码示例。
• gitignore: .gitignore 文件，定义了 Git 忽略的文件和目录。
• LICENSE.md: 项目使用的 MIT 许可证。
• README.md: 项目的主 README 文件，包含了项目的概述和基本使用说明。
• README-zh_CN.md: 项目的主 README 文件的中文名称版本。

具体目录结构如下：

rust-sokoban/
├── books/
│   ├── src/
│   │   └── SUMMARY.md
│   └── ...
├── code/
│   ├── rust-sokoban-c01-01/
│   ├── ...
│   └── ...
├── gitignore
├── LICENSE.md
├── README.md
└── README-zh_CN.md

2. 项目的启动文件介绍

项目的启动主要是通过 mdbook 工具来运行的。mdbook 是一个用于生成、预览和构建 mdbook 文档的工具。

在本地启动项目的步骤如下：

1. 首先确保已经安装了 mdbook。可以通过以下命令安装：

   cargo install mdbook
   

2. 使用 mdbook serve 命令来启动本地服务器并预览书籍：

   mdbook serve
   

   运行此命令后，教程文档将在本地 http://localhost:3000/ 上可用。

3. 项目的配置文件介绍

项目的配置主要在 books 目录下的 src/SUMMARY.md 文件中定义。这个文件定义了书籍的目录结构和各个章节的链接。

以下是一个示例的 SUMMARY.md 文件内容：

# 目录

## 第一章
- [1.1 节](01/01.md)
- [1.2 节](01/02.md)

## 第二章
- [2.1 节](02/01.md)
- [2.2 节](02/02.md)

...

在 SUMMARY.md 文件中，每个章节都需要有一个对应的 .md 文件在 src 目录下，按照上述格式进行引用。

通过修改 SUMMARY.md 文件，可以添加、删除或调整章节的顺序。每次修改后，重新运行 mdbook serve 命令即可看到最新的更改。

rust-sokoban Rust Sokoban book and code samples 项目地址: https://gitcode.com/gh_mirrors/ru/rust-sokoban