Skip to content

Commit e943e68

Browse files
committed
Port TRPL to mdbook
1. move everything under a src directory 2. add README.md to the SUMMARY.md
1 parent a076961 commit e943e68

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+146
-146
lines changed

src/doc/book/SUMMARY.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

src/doc/book/README.md renamed to src/doc/book/src/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% The Rust Programming Language
1+
# The Rust Programming Language
22

33
Welcome! This book will teach you about the [Rust Programming Language][rust].
44
Rust is a systems programming language focused on three goals: safety, speed,

src/doc/book/src/SUMMARY.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
11
# Summary
22

3-
- [Chapter 1](./chapter_1.md)
3+
[Introduction](README.md)
4+
5+
* [Getting Started](getting-started.md)
6+
* [Tutorial: Guessing Game](guessing-game.md)
7+
* [Syntax and Semantics](syntax-and-semantics.md)
8+
* [Variable Bindings](variable-bindings.md)
9+
* [Functions](functions.md)
10+
* [Primitive Types](primitive-types.md)
11+
* [Comments](comments.md)
12+
* [if](if.md)
13+
* [Loops](loops.md)
14+
* [Vectors](vectors.md)
15+
* [Ownership](ownership.md)
16+
* [References and Borrowing](references-and-borrowing.md)
17+
* [Lifetimes](lifetimes.md)
18+
* [Mutability](mutability.md)
19+
* [Structs](structs.md)
20+
* [Enums](enums.md)
21+
* [Match](match.md)
22+
* [Patterns](patterns.md)
23+
* [Method Syntax](method-syntax.md)
24+
* [Strings](strings.md)
25+
* [Generics](generics.md)
26+
* [Traits](traits.md)
27+
* [Drop](drop.md)
28+
* [if let](if-let.md)
29+
* [Trait Objects](trait-objects.md)
30+
* [Closures](closures.md)
31+
* [Universal Function Call Syntax](ufcs.md)
32+
* [Crates and Modules](crates-and-modules.md)
33+
* [`const` and `static`](const-and-static.md)
34+
* [Attributes](attributes.md)
35+
* [`type` aliases](type-aliases.md)
36+
* [Casting between types](casting-between-types.md)
37+
* [Associated Types](associated-types.md)
38+
* [Unsized Types](unsized-types.md)
39+
* [Operators and Overloading](operators-and-overloading.md)
40+
* [Deref coercions](deref-coercions.md)
41+
* [Macros](macros.md)
42+
* [Raw Pointers](raw-pointers.md)
43+
* [`unsafe`](unsafe.md)
44+
* [Effective Rust](effective-rust.md)
45+
* [The Stack and the Heap](the-stack-and-the-heap.md)
46+
* [Testing](testing.md)
47+
* [Conditional Compilation](conditional-compilation.md)
48+
* [Documentation](documentation.md)
49+
* [Iterators](iterators.md)
50+
* [Concurrency](concurrency.md)
51+
* [Error Handling](error-handling.md)
52+
* [Choosing your Guarantees](choosing-your-guarantees.md)
53+
* [FFI](ffi.md)
54+
* [Borrow and AsRef](borrow-and-asref.md)
55+
* [Release Channels](release-channels.md)
56+
* [Using Rust without the standard library](using-rust-without-the-standard-library.md)
57+
* [Procedural Macros (and custom derive)](procedural-macros.md)
58+
* [Nightly Rust](nightly-rust.md)
59+
* [Compiler Plugins](compiler-plugins.md)
60+
* [Inline Assembly](inline-assembly.md)
61+
* [No stdlib](no-stdlib.md)
62+
* [Intrinsics](intrinsics.md)
63+
* [Lang items](lang-items.md)
64+
* [Advanced linking](advanced-linking.md)
65+
* [Benchmark Tests](benchmark-tests.md)
66+
* [Box Syntax and Patterns](box-syntax-and-patterns.md)
67+
* [Slice Patterns](slice-patterns.md)
68+
* [Associated Constants](associated-constants.md)
69+
* [Custom Allocators](custom-allocators.md)
70+
* [Glossary](glossary.md)
71+
* [Syntax Index](syntax-index.md)
72+
* [Bibliography](bibliography.md)

src/doc/book/advanced-linking.md renamed to src/doc/book/src/advanced-linking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Advanced Linking
1+
# Advanced Linking
22

33
The common cases of linking with Rust have been covered earlier in this book,
44
but supporting the range of linking possibilities made available by other

src/doc/book/associated-constants.md renamed to src/doc/book/src/associated-constants.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Associated Constants
1+
# Associated Constants
22

33
With the `associated_consts` feature, you can define constants like this:
44

src/doc/book/associated-types.md renamed to src/doc/book/src/associated-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Associated Types
1+
# Associated Types
22

33
Associated types are a powerful part of Rust’s type system. They’re related to
44
the idea of a ‘type family’, in other words, grouping multiple types together. That

src/doc/book/attributes.md renamed to src/doc/book/src/attributes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Attributes
1+
# Attributes
22

33
Declarations can be annotated with ‘attributes’ in Rust. They look like this:
44

src/doc/book/benchmark-tests.md renamed to src/doc/book/src/benchmark-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Benchmark tests
1+
# Benchmark tests
22

33
Rust supports benchmark tests, which can test the performance of your
44
code. Let's make our `src/lib.rs` look like this (comments elided):

src/doc/book/bibliography.md renamed to src/doc/book/src/bibliography.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Bibliography
1+
# Bibliography
22

33
This is a reading list of material relevant to Rust. It includes prior
44
research that has - at one time or another - influenced the design of

src/doc/book/borrow-and-asref.md renamed to src/doc/book/src/borrow-and-asref.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
% Borrow and AsRef
1+
# Borrow and AsRef
22

33
The [`Borrow`][borrow] and [`AsRef`][asref] traits are very similar, but
44
different. Here’s a quick refresher on what these two traits mean.

0 commit comments

Comments
 (0)