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 ## Online tutorial
   7
   8 The most accessible form of the tutorial is its
   9 [online version](https://www.ralfj.de/projects/rust-101/main.html).
  10
  11 ## Offline Usage
  12
  13 You can either read through the sources in `src/`, or generate the
  14 HTML in `docs/` using `make docs`. This steps assumes `pipx install pycco` has
  15 been run before; it will use the pipx-created venv to import pycco.
  16
  17 The files `workspace/src/part*.rs` are generated by `make workspace`.
  18
  19 ## Source, License
  20
  21 You can find the sources in the [git
  22 repository](http://www.ralfj.de/git/rust-101.git) (also available [on
  23 GitHub](https://github.com/RalfJung/rust-101)).  They are provided
  24 under a Creative Commons Attribution-ShareAlike 4.0 International
  25 license ([CC-BY-SA
  26 4.0](https://creativecommons.org/licenses/by-sa/4.0/)). See the file
  27 `LICENSE-CC` for more details.
  28
  29 ## Contact
  30
  31 If you found a bug, or want to leave a comment, please [send me a
  32 mail](mailto:post-AT-ralfj-DOT-de). I'm also happy about pull requests
  33 :)