Comprehensive Rust 项目教程
项目的目录结构及介绍
Comprehensive Rust 项目的目录结构如下:
comprehensive-rust/
├── book/
│ ├── src/
│ │ ├── SUMMARY.md
│ │ ├── preface.md
│ │ ├── day1-morning.md
│ │ ├── day1-afternoon.md
│ │ ├── day2-morning.md
│ │ ├── day2-afternoon.md
│ │ ├── day3-morning.md
│ │ ├── day3-afternoon.md
│ │ ├── day4-morning.md
│ │ ├── day4-afternoon.md
│ │ ├── android.md
│ │ ├── chromium.md
│ │ ├── bare-metal.md
│ │ ├── concurrency.md
│ │ └── ...
│ ├── book.toml
│ └── ...
├── exercises/
│ ├── day1/
│ ├── day2/
│ ├── day3/
│ ├── day4/
│ └── ...
├── solutions/
│ ├── day1/
│ ├── day2/
│ ├── day3/
│ ├── day4/
│ └── ...
└── ...
目录结构介绍
book/
:包含课程的主要内容,分为多个章节,每个章节对应一天的学习内容。src/
:包含所有的 Markdown 文件,每个文件对应一个章节。SUMMARY.md
:目录文件,列出了所有章节及其链接。preface.md
:前言部分,介绍课程的背景和目标。day1-morning.md
至day4-afternoon.md
:每天的课程内容,分为上午和下午。android.md
、chromium.md
、bare-metal.md
、concurrency.md
:特定主题的深入内容。
book.toml
:配置文件,用于构建书籍。
exercises/
:包含每个章节的练习题。solutions/
:包含每个章节的练习题答案。
项目的启动文件介绍
Comprehensive Rust 项目没有传统的“启动文件”,因为它主要是一个教学资源,而不是一个可执行的应用程序。不过,你可以通过以下步骤来启动和浏览课程内容:
-
克隆仓库:
git clone https://github.com/google/comprehensive-rust.git
-
进入项目目录:
cd comprehensive-rust
-
构建书籍(假设你已经安装了
mdbook
):mdbook build
-
启动本地服务器:
mdbook serve
-
在浏览器中打开:
http://localhost:3000
项目的配置文件介绍
Comprehensive Rust 项目的主要配置文件是 book/book.toml
,它用于配置 mdbook
构建书籍的行为。以下是 book.toml
的一个示例:
[book]
title = "Comprehensive Rust"
author = "The Android Team at Google"
description = "A free Rust course developed by the Android team at Google."
[build]
build-dir = "book"
[preprocessor.links]
[output.html]
additional-css = ["css/custom.css"]
[output.html.fold]
enable = true
配置文件介绍
[book]
:配置书籍的基本信息,如标题、作者和描述。[build]
:配置构建目录。[preprocessor.links]
:配置预处理器,用于处理链接。[output.html]
:配置 HTML 输出,如额外的 CSS 文件。[output.html.fold]
:配置是否启用折叠功能。
通过这些配置,你可以自定义书籍的构建和展示方式。