X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/259b6c2c62cc3695c3e6fa068aea8ba4411d6150..dbe5e64bd7e47fd8ab3f7e8b1dc22c55b1fb39f3:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 23091bd..c163e7f 100644 --- 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/). +**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 toturial is its +The most accessible form of the tutorial is its [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 -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`.