fix the patching monkeys

[rust-101.git] / README.rst

diff --git a/README.rst b/README.rst
index ae56d3f6dafd9212c764d339da0d200b672407bf..158fc732df4adbfa65cede14ce21af15480b5484 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,38 @@
 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 documents Rust-101, a tutorial for the `Rust language`_. You are probably 
+looking for the `actual tutorial <https://www.ralfj.de/projects/rust-101/main.html>`_.
 
 .. _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/
+
+Contact
+-------
+
+If you found a bug, or want to leave a comment, please
+`send me a mail <mailto:post-AT-ralfj-DOT-de>`_. I'm also happy about pull
+requests :)