Skip to content

Commit a1c354e

Browse files
committed
Update README links to GitHub Pages and fix serve display URL
- Point all book links to https://microsoft.github.io/RustTraining/ - Add local preview instructions with git clone, rustup, cargo xtask serve - Show localhost:3000 in serve console message
1 parent ad52034 commit a1c354e

2 files changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,25 +45,25 @@ Pick the book that matches your background. Books are grouped by complexity so y
4545

4646
| Book | Level | Who it's for |
4747
|------|-------|-------------|
48-
| [**Rust for C/C++ Programmers**](c-cpp-book/src/SUMMARY.md) | 🟢 Bridge | Move semantics, RAII, FFI, embedded, no_std |
49-
| [**Rust for C# Programmers**](csharp-book/src/SUMMARY.md) | 🟢 Bridge | Swift / C# / Java → ownership & type system |
50-
| [**Rust for Python Programmers**](python-book/src/SUMMARY.md) | 🟢 Bridge | Dynamic → static typing, GIL-free concurrency |
51-
| [**Async Rust**](async-book/src/SUMMARY.md) | 🔵 Deep Dive | Tokio, streams, cancellation safety |
52-
| [**Rust Patterns**](rust-patterns-book/src/SUMMARY.md) | 🟡 Advanced | Pin, allocators, lock-free structures, unsafe |
53-
| [**Type-Driven Correctness**](type-driven-correctness-book/src/SUMMARY.md) | 🟣 Expert | Type-state, phantom types, capability tokens |
54-
| [**Rust Engineering Practices**](engineering-book/src/SUMMARY.md) | 🟤 Practices | Build scripts, cross-compilation, CI/CD, Miri |
48+
| [**Rust for C/C++ Programmers**](https://microsoft.github.io/RustTraining/c-cpp-book/) | 🟢 Bridge | Move semantics, RAII, FFI, embedded, no_std |
49+
| [**Rust for C# Programmers**](https://microsoft.github.io/RustTraining/csharp-book/) | 🟢 Bridge | Swift / C# / Java → ownership & type system |
50+
| [**Rust for Python Programmers**](https://microsoft.github.io/RustTraining/python-book/) | 🟢 Bridge | Dynamic → static typing, GIL-free concurrency |
51+
| [**Async Rust**](https://microsoft.github.io/RustTraining/async-book/) | 🔵 Deep Dive | Tokio, streams, cancellation safety |
52+
| [**Rust Patterns**](https://microsoft.github.io/RustTraining/rust-patterns-book/) | 🟡 Advanced | Pin, allocators, lock-free structures, unsafe |
53+
| [**Type-Driven Correctness**](https://microsoft.github.io/RustTraining/type-driven-correctness-book/) | 🟣 Expert | Type-state, phantom types, capability tokens |
54+
| [**Rust Engineering Practices**](https://microsoft.github.io/RustTraining/engineering-book/) | 🟤 Practices | Build scripts, cross-compilation, CI/CD, Miri |
5555

5656
Each book has 15–16 chapters with Mermaid diagrams, editable Rust playgrounds, exercises, and full-text search.
5757

58-
> **Tip:** You can read the markdown source directly on GitHub, or browse the rendered site with sidebar navigation and search at the [GitHub Pages site](https://microsoft.github.io/RustTraining/).
58+
> **Tip:** Browse the rendered books with sidebar navigation and search at the [GitHub Pages site](https://microsoft.github.io/RustTraining/).
5959
>
60-
> **Local serving:** For the best reading experience (keyboard navigation between chapters, instant search, offline access), clone the repo and run:
60+
> **Local preview:** For offline reading or while contributing:
6161
> ```
62-
> # Install Rust via rustup if you don't have it yet:
63-
> # https://rustup.rs/
64-
>
65-
> cargo install mdbook@0.4.52 mdbook-mermaid@0.14.0
66-
> cargo xtask serve # builds all books and opens a local server
62+
> # Install Rust via rustup if you don't have it: https://rustup.rs/
63+
> git clone https://github.com/microsoft/RustTraining.git
64+
> cd RustTraining
65+
> cargo install mdbook mdbook-mermaid
66+
> cargo xtask serve # http://localhost:3000
6767
> ```
6868
6969
---

xtask/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ fn cmd_serve() {
414414
// Handle Ctrl+C gracefully so cargo doesn't report an error
415415
ctrlc_exit();
416416

417-
println!("\nServing at http://{addr} (Ctrl+C to stop)");
417+
println!("\nServing at http://localhost:3000 (Ctrl+C to stop)");
418418

419419
for stream in listener.incoming() {
420420
let Ok(mut stream) = stream else { continue };

0 commit comments

Comments
 (0)