X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/ae22b72e84239a39978aed2cf329f52c86711aa9..188b1ec1b8528e2326791feccc8077e15bd60182:/README.rst diff --git a/README.rst b/README.rst index ae56d3f..3d4188f 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,30 @@ Rust-101 ======== -This is Rust-101, a tutorial for the `Rust language`_. You can either read -through the sources in ``src/``, or generate the HTML in ``docs/`` using ``docco -src/*.rs`` (this step needs Docco_), or go directly to `the rendered output`_. +This is Rust-101, a tutorial for the `Rust language`_. .. _Rust language: http://www.rust-lang.org/ -.. _Docco: https://jashkenas.github.io/docco/ -.. _the rendered output: https://ralfjung.github.io/rust-101/main.html + +Usage +----- + +You can either read through the sources in ``src/``, or generate the HTML in +``docs/`` using ``make docs`` (this step needs Pycco_), or go directly to +`the rendered output`_. + +The files ``workspace/src/part*.rs`` are generated by ``make workspace``. + +.. _Pycco: https://fitzgen.github.io/pycco/ +.. _the rendered output: https://www.ralfj.de/projects/rust-101/main.html + +Source, License +--------------- + +You can find the sources in the `git repository`_ (also available `on GitHub`_). +They are provided under a Creative Commons Attribution-ShareAlike 4.0 +International license (`CC-BY-SA 4.0`_). See the file ``LICENSE-CC`` for more +details. + +.. _git repository: http://www.ralfj.de/git/rust-101.git +.. _on GitHub: https://github.com/RalfJung/rust-101 +.. _CC-BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/