X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/3449141636aeba89b2b768c8362a15fdd76c0a94..refs/heads/master:/README.md diff --git a/README.md b/README.md index 23f5f40..c163e7f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,25 @@ # 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`. -Source, License ---------------- +## Source, License You can find the sources in the [git repository](http://www.ralfj.de/git/rust-101.git) (also available [on @@ -26,8 +29,7 @@ license ([CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)). See the file `LICENSE-CC` for more details. -Contact -------- +## Contact If you found a bug, or want to leave a comment, please [send me a mail](mailto:post-AT-ralfj-DOT-de). I'm also happy about pull requests