From: Ralf Jung Date: Mon, 8 Jun 2015 20:29:57 +0000 (+0200) Subject: add a Makefile X-Git-Url: https://git.ralfj.de/rust-101.git/commitdiff_plain/7858ea50a3c07211952b5d26c855d59a00d6dd92 add a Makefile --- diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..cb4172e --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +all: docs +.PHONY: docs + +docs: + docco src/*.rs -l linear diff --git a/README.rst b/README.rst index 40bb559..8263e55 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ Usage ----- 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 +``docs/`` using ``make docs`` (this step needs Docco_), or go directly to `the rendered output`_. Source, License diff --git a/src/main.rs b/src/main.rs index 51de479..98bf6c1 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,7 +1,7 @@ // Welcome to Rust-101 // =================== // -// This is Rust-101, a small tutorial to the [Rust language](http://www.rust-lang.org/). +// This is [Rust-101](https://www.ralfj.de/projects/rust-101/), a small tutorial for the [Rust language](http://www.rust-lang.org/). // This is intended to be an interactive, hands-on course: I believe the only way to // *really* learn a language is to write code in it, so you should be coding during // the course. These documents mainly serve as a guide to the teacher, reminding me @@ -51,5 +51,3 @@ fn main() { // * [The Rust Book](https://doc.rust-lang.org/stable/book/) // * [Rust by Example](http://rustbyexample.com/) // * The [Rust Subreddit](https://www.reddit.com/r/rust/) - -// (This website has been generated with [Docco](https://jashkenas.github.io/docco/))