Merge pull request #20 from avkrotov/reference

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

diff --git a/src/main.rs b/src/main.rs
index b08b1dae7663c84d12a1e17eca6e495ee0cf2593..835a150d537c7e72507031ea256b1eee3c72f774 100644 (file)
--- a/src/main.rs
+++ b/src/main.rs
@@ -2,7 +2,7 @@
 // ===================
 // 
 // This is [Rust-101](https://www.ralfj.de/projects/rust-101/), a small tutorial for
 // ===================
 // 
 // This is [Rust-101](https://www.ralfj.de/projects/rust-101/), a small tutorial for

-// the [Rust language](http://www.rust-lang.org/). It is intended to be an interactive,
+// the [Rust language](https://www.rust-lang.org/). It 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.
 // 
 // 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.
 // 


@@ -23,36 +23,32 @@
 // 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 with the comfort of high-level functional languages and guaranteed
 // 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 with the comfort of high-level functional languages and guaranteed

-// safety (as in, the program will not crash). The vast majority of existing
-// languages sacrifices one of these goals for the other. In particular, the
-// first requirement rules out a garbage collector: Rust can run "bare metal".
-// In fact, Rust rules out more classes of bugs than languages that achieve safety
-// with a GC: Besides dangling pointers and double-free, Rust also prevents issues
-// such as iterator invalidation and data races.
+// safety (as in, the program will not crash in uncontrolled ways). The vast majority of existing
+// languages sacrifices control for safety (for example, by enforcing the usage of
+// a garbage collector) or vice versa. Rust can run without dynamic allocation (i.e., without
+// a heap), and even without an operating system. In fact, Rust rules out more classes of bugs
+// than languages that achieve safety with a garbage collector: Besides dangling pointers and
+// double-free, Rust also prevents issues such as iterator invalidation and data races. Finally,
+// it cleans up behind you, and deallocates resources (memory, but also file descriptors and really
+// anything) when you don't need them anymore.

 // 
 // 
 // Getting started
 // ---------------
 // 
 // You will need to have Rust installed, of course. It is available for download on
 // 
 // 
 // 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/). Make sure you get at least version 1.2
-// (at the time of writing, that's the current beta release). More detailed installation
-// instructions are provided in [the second chapter of The Book](https://doc.rust-lang.org/stable/book/installing-rust.html).
+// [the Rust website](https://www.rust-lang.org/). Make sure you get at least version 1.3.
+// More detailed installation instructions are provided in
+// [The Book](https://doc.rust-lang.org/stable/book/).

 // This will also install `cargo`, the tool responsible for building rust projects (or *crates*).
 // This will also install `cargo`, the tool responsible for building rust projects (or *crates*).

-
-// 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), and as a
-// [zip archive](https://github.com/RalfJung/rust-101/archive/master.zip) in case you don't have git installed).
-// 
-// There is a workspace prepared for you in the `workspace` folder. I suggest you copy this
-// folder somewhere else - that will make it much easier to later update the course without
-// overwriting your changes. Try `cargo build` in that new folder to check that compiling your workspace succeeds.
-// (You can also execute it with `cargo run`, but you'll need to do some work before this will succeed.)
-// 
-// If you later want to update the course, do `git pull` (or re-download the zip archive).
-// Then copy the files from `workspace/src/` to your workspace that you did not yet work on. Definitely
-// copy `main.rs` to make sure all the new files are actually compiled. (Of course you can also
-// copy the rest, but that would replace all your hard work by the original files with all the holes!)
+// 
+// Next, we have to prepare a workspace for you to conduct your Rust-101 work in, so that you don't
+// have to start with an empty file. The easiest way is to [download the workspace](https://www.ralfj.de/projects/rust-101/workspace.zip)
+// matching the online tutorial. Try `cargo build` in that new folder to check that compiling your workspace succeeds.
+// (You can also execute it with `cargo run`, but you'll need to do some work before this does anything useful.)
+// 
+// Alternatively, you can build the workspace from source by fetching the [git repository](https://www.ralfj.de/git/rust-101.git)
+// and running `make workspace`.

 
 // Course Content
 // --------------
 
 // Course Content
 // --------------


@@ -69,7 +65,7 @@
 // 
 // ### Basic Rust
 // 
 // 
 // ### Basic Rust
 // 

-// * [Part 04: Ownership, Borrowing](part04.html)
+// * [Part 04: Ownership, Borrowing, References](part04.html)

 // * [Part 05: Clone](part05.html)
 // * [Part 06: Copy, Lifetimes](part06.html)
 // * [Part 07: Operator Overloading, Tests, Formating](part07.html)
 // * [Part 05: Clone](part05.html)
 // * [Part 06: Copy, Lifetimes](part06.html)
 // * [Part 07: Operator Overloading, Tests, Formating](part07.html)


@@ -123,4 +119,4 @@ fn main() {
 // * [Rust by Example](http://rustbyexample.com/)
 // * The [Rust Subreddit](https://www.reddit.com/r/rust/)
 // * A [collection of links](https://github.com/ctjhoa/rust-learning) to blog posts, articles, videos, etc. for learning Rust.
 // * [Rust by Example](http://rustbyexample.com/)
 // * The [Rust Subreddit](https://www.reddit.com/r/rust/)
 // * A [collection of links](https://github.com/ctjhoa/rust-learning) to blog posts, articles, videos, etc. for learning Rust.

-// * For the IRC channel and other forums, see the "Community" section of the [Rust Documentation index](http://doc.rust-lang.org/index.html)
+// * For the IRC channel and other forums, see the "Community" section of the [Rust Documentation index](https://doc.rust-lang.org/index.html)