README.md

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