switch from pycco and md to docco and rst

[rust-101.git] / README.rst

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..ae56d3f
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,10 @@
+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`_.
+
+.. _Rust language: http://www.rust-lang.org/
+.. _Docco: https://jashkenas.github.io/docco/
+.. _the rendered output: https://ralfjung.github.io/rust-101/main.html