Merge pull request #42 from zdyxry/master

[rust-101.git] / README.md

diff --git a/README.md b/README.md
index 406acadd5a760680c4b5355bc6ba1b4c8f711385..494099fd94eebaee3c068601dd48b63d147d9664 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,33 @@
-Rust-101
-========
+# Rust-101

 
 

-This is Rust-101, a tutorial for the [Rust language](http://www.rust-lang.org/).
-You can either read through the sources in `src/`, or generate the HTML
-in `docs/` using `./pycco-rs src/*.rs`, or go directly to
-[the rendered output](https://ralfjung.github.io/rust-101/main.html).
+This documents Rust-101, a tutorial for the [Rust
+language](http://www.rust-lang.org/).
+
+## Online tutorial
+
+The most accessible form of the tutorial is its
+[online version](https://www.ralfj.de/projects/rust-101/main.html).
+
+## Offline Usage
+
+You can either read through the sources in `src/`, or generate the
+HTML in `docs/` using `make docs`. This steps assumes `pipx install pycco` has
+been run before; it will use the pipx-created venv to import pycco.
+
+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
+:)