X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/7858ea50a3c07211952b5d26c855d59a00d6dd92..6b347ac8c0f8710bd0ca42d20d32511fcb53f188:/README.rst diff --git a/README.rst b/README.rst index 8263e55..158fc73 100644 --- a/README.rst +++ b/README.rst @@ -1,26 +1,38 @@ Rust-101 ======== -This is Rust-101, a tutorial for the `Rust language`_. +This documents Rust-101, a tutorial for the `Rust language`_. You are probably +looking for the `actual tutorial `_. .. _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 Docco_), or go directly to +``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`_ and `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. +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/ + +Contact +------- + +If you found a bug, or want to leave a comment, please +`send me a mail `_. I'm also happy about pull +requests :)