40bb559ed16f56c110b116d6b3c8c82fb2a3c123
[rust-101.git] / README.rst
1 Rust-101
2 ========
3
4 This is Rust-101, a tutorial for the `Rust language`_.
5
6 .. _Rust language: http://www.rust-lang.org/
7 .. _Docco: https://jashkenas.github.io/docco/
8 .. _the rendered output: https://ralfjung.github.io/rust-101/main.html
9
10 Usage
11 -----
12
13 You can either read through the sources in ``src/``, or generate the HTML in 
14 ``docs/`` using ``docco src/*.rs`` (this step needs Docco_), or go directly to 
15 `the rendered output`_.
16
17 Source, License
18 ---------------
19
20 You can find the sources in the `git repository`_ and `on GitHub`_. They are 
21 provided under a Creative Commons Attribution-ShareAlike 4.0 International 
22 license (`CC-BY-SA 4.0`_). See the file ``LICENSE-CC`` for more details.
23
24 .. _git repository: http://www.ralfj.de/git/rust-101.git
25 .. _on GitHub: https://github.com/RalfJung/rust-101
26 .. _CC-BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/