X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/2022af3d411f12b637e40bcac62b73d97d7fc091..dbe5e64bd7e47fd8ab3f7e8b1dc22c55b1fb39f3:/README.md diff --git a/README.md b/README.md index 7895b8b..c163e7f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,21 @@ # Rust-101 This documents Rust-101, a tutorial for the [Rust -language](http://www.rust-lang.org/). You are probably looking for the -[actual tutorial](https://www.ralfj.de/projects/rust-101/main.html). +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.** -## Usage +## Online tutorial + +The most accessible form of the tutorial is its +[online version](https://www.ralfj.de/projects/rust-101/main.html). + +## 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://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`.