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 easiest way to the toturial is to check out its
   9 [online version](https://www.ralfj.de/projects/rust-101/main.html).
  10
  11 ## Usage
  12
  13 You can either read through the sources in `src/`, or generate the
  14 HTML in `docs/` using `make docs` (this step needs
  15 [Pycco](https://fitzgen.github.io/pycco/)), or go directly to [the
  16 rendered output](https://www.ralfj.de/projects/rust-101/main.html).
  17
  18 The files `workspace/src/part*.rs` are generated by `make workspace`.
  19
  20 ## Source, License
  21
  22 You can find the sources in the [git
  23 repository](http://www.ralfj.de/git/rust-101.git) (also available [on
  24 GitHub](https://github.com/RalfJung/rust-101)).  They are provided
  25 under a Creative Commons Attribution-ShareAlike 4.0 International
  26 license ([CC-BY-SA
  27 4.0](https://creativecommons.org/licenses/by-sa/4.0/)). See the file
  28 `LICENSE-CC` for more details.
  29
  30 ## Contact
  31
  32 If you found a bug, or want to leave a comment, please [send me a
  33 mail](mailto:post-AT-ralfj-DOT-de). I'm also happy about pull requests
  34 :)