switch from pycco and md to docco and rst

[rust-101.git] / src / main.rs

diff --git a/src/main.rs b/src/main.rs
index 7bf7dbea29d520bf23d416f34255a88f17681979..51de479ea8c53fe4fae1514179edf8fea7a22bb3 100644 (file)
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,4 +1,3 @@
-#![allow(dead_code)]
 // Welcome to Rust-101
 // ===================
 //
@@ -9,18 +8,48 @@
 // what to explain in which order, and making sure I have sample code for all topics
 // I plan to cover. They may also be helpful as an offline resource, but you're on your
 // own then.
-
+// 
+// I will assume basic familiarity with programming, and hence not explain the basic
+// concepts common to most languages. Instead, I will focus on what makes Rust special.
+//
+// Prerequisites
+// -------------
+//
+// You will need to have Rust installed, of course. It is available for download on
+// [the Rust website](http://www.rust-lang.org/). At this point, I plan to restrict
+// myself to stable Rust, so "Recommended" version is just right.
+// You can find some more installation instructions in
+// [the second chapter of The Book](https://doc.rust-lang.org/stable/book/installing-rust.html).
+// When you are done, running `cargo build` in the root of Rust-101 should successfully compile
+// all the code.
+//
+// Course Content
+// --------------
+// 
 // The actual course is in the partXX.rs files. I suggest you get started with
 // [the first part](part00.html), or jump directly to where you left off:
-
+// 
 // * [Part 00](part00.html)
 // * [Part 01](part01.html)
+#![allow(dead_code)]
 mod part00;
 mod part01;
 
-// To actually run the code after filling in the blanks, simply edit the `main`
+// To actually run the code of some part (after filling in the blanks, if necessary), simply edit the `main`
 // function below.
 
 fn main() {
     part00::part_main();
 }
+
+// Additional material
+// -------------------
+// 
+// There's tons of useful Rust stuff out there, so let me just put links to some
+// of the most interesting places here:
+// 
+// * [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/))