add a note to the README about this being a tutorial for an ancient version of Rust

[rust-101.git] / README.md

diff --git a/README.md b/README.md
index acef159bb30851fc96687e04a634ce922b611ab8..c163e7f6c1b67d57c529e5800e7a844e84c6bfd2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,17 +3,19 @@
 This documents Rust-101, a tutorial for the [Rust
 language](http://www.rust-lang.org/).
 
 This documents Rust-101, a tutorial for the [Rust
 language](http://www.rust-lang.org/).
 

+**Note that this tutorial was written for Rust 1.3 in 2015, and the language evolved a lot since then.
+Some of the idioms presented here may no longer reflect current practice.**
+

 ## Online tutorial
 
 ## Online tutorial
 

-The easiest way to the toturial is to check out its
+The most accessible form of the tutorial is its

 [online version](https://www.ralfj.de/projects/rust-101/main.html).
 
 [online version](https://www.ralfj.de/projects/rust-101/main.html).
 

-## Usage
+## Offline Usage

 
 You can either read through the sources in `src/`, or generate the
 
 You can either read through the sources in `src/`, or generate the

-HTML in `docs/` using `make docs` (this step needs
-[Pycco](https://fitzgen.github.io/pycco/)), or go directly to [the
-rendered output](https://www.ralfj.de/projects/rust-101/main.html).
+HTML in `docs/` using `make docs`. This steps assumes `pipx install pycco` has
+been run before; it will use the pipx-created venv to import pycco.

 
 The files `workspace/src/part*.rs` are generated by `make workspace`.
 
 
 The files `workspace/src/part*.rs` are generated by `make workspace`.