X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/e726c740aaf22cc99aab03063df3854595bc458c..e7d7a4a73b044faa7f3959b9c48e1919bef0d54e:/README.rst diff --git a/README.rst b/README.rst index 9ce0685..158fc73 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,8 @@ 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/ @@ -9,10 +10,12 @@ 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`_. -.. _Docco: https://jashkenas.github.io/docco/ +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 @@ -26,3 +29,10 @@ 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 :)