README.rst

   1 Rust-101
   2 ========
   3
   4 This is Rust-101, a tutorial for the `Rust language`_.
   5
   6 .. _Rust language: http://www.rust-lang.org/
   7
   8 Usage
   9 -----
  10
  11 You can either read through the sources in ``src/``, or generate the HTML in
  12 ``docs/`` using ``make docs`` (this step needs Pycco_), or go directly to
  13 `the rendered output`_.
  14
  15 The files ``workspace/src/part*.rs`` are generated by ``make workspace``.
  16
  17 .. _Pycco: https://fitzgen.github.io/pycco/
  18 .. _the rendered output: https://www.ralfj.de/projects/rust-101/main.html
  19
  20 Source, License
  21 ---------------
  22
  23 You can find the sources in the `git repository`_ (also available `on GitHub`_).
  24 They are provided under a Creative Commons Attribution-ShareAlike 4.0
  25 International license (`CC-BY-SA 4.0`_). See the file ``LICENSE-CC`` for more
  26 details.
  27
  28 .. _git repository: http://www.ralfj.de/git/rust-101.git
  29 .. _on GitHub: https://github.com/RalfJung/rust-101
  30 .. _CC-BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/