# rust-reference

**Repository Path**: unbreakablehf/rust-reference

## Basic Information

- **Project Name**: rust-reference
- **Description**: Rust Reference 的中文翻译，预期能及时和原文保持同步
- **Primary Language**: Rust
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 34
- **Created**: 2020-11-07
- **Last Updated**: 2024-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# The Rust Language Reference

This document is the primary reference for the Rust programming language.

This document is not normative. It may include details that are specific
to `rustc` itself, and should not be taken as a specification for the
Rust language. We intend to produce such a document someday, but this is
what we have for now.

## Dependencies

- rustc (the Rust compiler).
- [mdbook](https://github.com/rust-lang/mdBook) (use `cargo install mdbook` to install it).

## Build steps

First, go to the repository folder and test the code snippets to catch
compilation errors:

```sh
cd reference
mdbook test
```

And then generate the book:

```sh
mdbook build
```

The generated HTML will be in the `book` folder.

## Online Reading
You can preview the whole content on [Web](https://minstrel1977.gitee.io/rust-reference).