add some @-magic to generate a workspace

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

diff --git a/src/main.rs b/src/main.rs
index 31537dfc5284882dfe6c3aa529af907387928049..d7dbcb06daaffd41b7b2527d92dd6513f040463a 100644 (file)
--- a/src/main.rs
+++ b/src/main.rs
@@ -27,8 +27,8 @@
 // At this time, Rust is a language with a pretty unique set of goals. Rust aims to
 // achieve C++-style control over memory and execution behavior (like, static vs. dynamic
 // dispatch), which makes it possible to construct abstractions that carry no run-time
-// cost. This is combined this with providing the comfort of high-level functional languages
-// and guaranteeing safety (as in, the program will not crash). The vast majority of existing
+// cost. This is combined with the comfort of high-level functional languages and guaranteed
+// safety (as in, the program will not crash). The vast majority of existing
 // languages sacrificies one of these goals for the other. In particular, the
 // first requirement rules out a garbage collector: Rust can run "mare metal".
 // In fact, Rust rules out more classes of bugs than languages that achieve safety
@@ -36,23 +36,27 @@
 // such as iterator invalidation and race conditions.
 // 
 // 
-// Prerequisites
-// -------------
+// Getting started
+// ---------------
 // 
 // 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.
+
+// Next, fetch the Rust-101 source code from the [git repository](http://www.ralfj.de/git/rust-101.git)
+// (also available [on GitHub](https://github.com/RalfJung/rust-101)). Running `cargo build`
+// in the root of the repository should now succeed.
 // 
-// Getting the source
-// ------------------
+// I suggest you copy the folder `workspace` somewhere you like, so that you can still easily
+// `git pull` updates in the main repository. After copying, try `cargo build` in the
+// new location. It should complain about `part00::main()` not being found. Now you can start
+// by following [Part 00](part00.html), typing in `part00.rs`. If you need to add a new file, remember to also
+// add it to `main.rs` so that Rust finds it.
 // 
-// You are meant to play around with the source code of the course as you go on, so please
-// fetch it from the [git repository](http://www.ralfj.de/git/rust-101.git) (also available
-// [on GitHub](https://github.com/RalfJung/rust-101)).
+// If you do not want to copy all the code yourself, and wish to start with my code and just edit
+// it, you can copy the files from `src` in this repository, to `src` in your workspace copy.
 
 // Course Content
 // --------------
@@ -64,16 +68,16 @@
 // Rust. Finally, in parts ??-??, we implement our own version of `grep`, exhibiting useful Rust
 // features as we go.
 // 
-// I suggest you get started with [the first part](part00.html), or jump directly to where you left off:
+// You should start with [the first part](part00.html), or jump directly to where you left off:
 // 
 // * [Part 00: Algebraic datatypes](part00.html)
 // * [Part 01: Expressions, Inherent methods](part01.html)
 // * [Part 02: Generic types, Traits](part02.html)
 // * [Part 03: Input](part03.html)
 // * [Part 04: Ownership, Borrowing](part04.html)
-// * [Part 05: Clone](part05.html) (WIP)
-// * [Part 06: Copy, Lifetimes](part06.html) (WIP)
-// * [Part 07: Operator Overloading, Tests, Output](part07.html) (WIP)
+// * [Part 05: Clone](part05.html)
+// * [Part 06: Copy, Lifetimes](part06.html)
+// * [Part 07: Operator Overloading, Tests, Formating](part07.html)
 // * (to be continued)
 #![allow(dead_code, unused_imports, unused_variables, unused_mut)]
 mod part00;
@@ -91,7 +95,7 @@ mod part09;
 // function.
 
 fn main() {
-    part03::main();
+    part00::main();
 }
 
 // Additional material