X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/d7b96e63505812685191c3dad091453284892943..3dc9d065dfa259c88b3109717e2c6f6e65a45cc4:/README.rst?ds=sidebyside diff --git a/README.rst b/README.rst index 40bb559..9ce0685 100644 --- a/README.rst +++ b/README.rst @@ -4,22 +4,24 @@ Rust-101 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 ``docco src/*.rs`` (this step needs Docco_), or go directly to +``docs/`` using ``make docs`` (this step needs Docco_), or go directly to `the rendered output`_. +.. _Docco: https://jashkenas.github.io/docco/ +.. _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