README.rst

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