Rust 官方文档
Rust 语言的学习或参考文档大都列在 Rust 学习指引页 和 Rust 官方文档主页 上,目前 Rust 官方团队已经将相关文档拆分到不同的仓库上:
- 《Rust 程序设计语言》(The Rust Programming Language),对应 GitHub 仓库
- 《通过例子学 Rust》(Rust by Example),对应 GitHub 仓库
- Rust 版本指南(The Edition Guide),对应 GitHub 仓库
- Cargo 帮助文档,对应 GitHub 仓库源文件
- rustdoc 帮助文档,对应 GitHub 仓库源文件
- rustc 帮助文档,对应 GitHub 仓库源文件
- Rust 编译错误索引,对应 GitHub 仓库源代码
- 《Rust 语言参考》(The Rust Reference),对应 GitHub 仓库
- The Rustonomicon,对应 GitHub 仓库
以上文档优先处理,这些文档都循序渐进翻译成中文文档。还有其他更多官方或其他非官方相关的文档:
- 使用 Rust 编写命令行应用,对应 GitHub 仓库地址
- Rust 和 WebAssembly 教程(WebAssembly Book),对应 GitHub 仓库
- 嵌入式 Rust 教程,对应 GitHub 仓库
- A Rust Cookbook,对应 GitHub 仓库
- The Unstable Book,对应 GitHub 仓库源代码
- rustc 指引——Rust 编译器的工作原理及如何参与贡献(rustc-guide),对应 GitHub 仓库
- rustup 命令说明,本翻译项目会将
rustup
的相关说明翻译成中文 - Rust RFC——Rust 发展相关制定的文稿,对应 GitHub 仓库
- mdBook 使用手册,对应 GitHub 仓库
- Rust API 指导原则,对应 GitHub 仓库
- async-book,对应 GitHub 仓库
上述文档的源文件有些是放在 rust 和 cargo 的仓库的子目录中:Rust 文档 和 cargo 文档。
另外除了 README.md
文件外,还可以创建 CONTRIBUTING.md
和 CONTRIBUTORS.md
文件,前者是介绍如何参与项目的指南文件,后者可以列出参与项目的贡献者名单。这两份文件上,可以保留原文件基础上,再加上如何翻译的介绍和翻译者等信息。
rust-lang-cn 项目组已经翻译好的 《通过例子学 Rust》就是按照这些原则进行的。