X-Git-Url: https://git.ralfj.de/rust-101.git/blobdiff_plain/4c7f5b23c9bd4cedc1374fd692edc5edf06b701f..7df9cdaae2db9969c8b83c4c69ccc21eb0973eb4:/README.md diff --git a/README.md b/README.md index 406acad..7895b8b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,31 @@ -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/). 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 +:)