X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/e50539ecd5ce8becea63c915568192264c595d84..dbe5e64bd7e47fd8ab3f7e8b1dc22c55b1fb39f3:/README.md diff --git a/README.md b/README.md index be0e4fb..c163e7f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ 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 The most accessible form of the tutorial is its @@ -11,8 +14,8 @@ The most accessible form of the tutorial is its ## Offline Usage You can either read through the sources in `src/`, or generate the -HTML in `docs/` using `make docs` (this step needs -[Pycco](https://pycco-docs.github.io/pycco/)). +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`.