From: Ralf Jung <post@ralfj.de>
Date: Thu, 8 Oct 2015 08:25:32 +0000 (+0200)
Subject: convert README to markdown
X-Git-Url: https://git.ralfj.de/rust-101.git/commitdiff_plain/3449141636aeba89b2b768c8362a15fdd76c0a94

convert README to markdown
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23f5f40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Rust-101
+
+This documents Rust-101, a tutorial for the [Rust
+language](http://www.rust-lang.org/). You are probably looking for the
+[actual tutorial](https://www.ralfj.de/projects/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](https://fitzgen.github.io/pycco/)), or go directly to [the
+rendered output](https://www.ralfj.de/projects/rust-101/main.html).
+
+The files `workspace/src/part*.rs` are generated by `make workspace`.
+
+Source, License
+---------------
+
+You can find the sources in the [git
+repository](http://www.ralfj.de/git/rust-101.git) (also available [on
+GitHub](https://github.com/RalfJung/rust-101)).  They are provided
+under a Creative Commons Attribution-ShareAlike 4.0 International
+license ([CC-BY-SA
+4.0](https://creativecommons.org/licenses/by-sa/4.0/)). See the file
+`LICENSE-CC` for more details.
+
+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
+:)
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 158fc73..0000000
--- a/README.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-Rust-101
-========
-
-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/
-
-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 :)