README.md

   1 # Rust-101
   2
   3 This documents Rust-101, a tutorial for the [Rust
   4 language](http://www.rust-lang.org/).
   5
   6 **Note that this tutorial was written for Rust 1.3 in 2015, and the language evolved a lot since then.
   7 Some of the idioms presented here may no longer reflect current practice.**
   8
   9 ## Online tutorial
  10
  11 The most accessible form of the tutorial is its
  12 [online version](https://www.ralfj.de/projects/rust-101/main.html).
  13
  14 ## Offline Usage
  15
  16 You can either read through the sources in `src/`, or generate the
  17 HTML in `docs/` using `make docs`. This steps assumes `pipx install pycco` has
  18 been run before; it will use the pipx-created venv to import pycco.
  19
  20 The files `workspace/src/part*.rs` are generated by `make workspace`.
  21
  22 ## Source, License
  23
  24 You can find the sources in the [git
  25 repository](http://www.ralfj.de/git/rust-101.git) (also available [on
  26 GitHub](https://github.com/RalfJung/rust-101)).  They are provided
  27 under a Creative Commons Attribution-ShareAlike 4.0 International
  28 license ([CC-BY-SA
  29 4.0](https://creativecommons.org/licenses/by-sa/4.0/)). See the file
  30 `LICENSE-CC` for more details.
  31
  32 ## Contact
  33
  34 If you found a bug, or want to leave a comment, please [send me a
  35 mail](mailto:post-AT-ralfj-DOT-de). I'm also happy about pull requests
  36 :)