convert README to markdown

[rust-101.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
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
+:)