From a49a22071ab0c675e43e03ab9c08b0153d8f9c74 Mon Sep 17 00:00:00 2001 From: liv Date: Wed, 23 Jan 2019 21:02:06 +0100 Subject: [PATCH] redo the section readmes --- exercises/functions/REAMDE.md | 8 +++++++- exercises/if/README.md | 7 +++++++ exercises/if/REAMDE.md | 1 - exercises/macros/README.md | 12 ++++++++++-- exercises/modules/README.md | 8 +++++++- exercises/move_semantics/README.md | 13 ++++++++----- exercises/primitive_types/README.md | 9 ++++++++- exercises/strings/REAMDE.md | 10 +++++++++- exercises/tests/README.md | 6 +++++- exercises/variables/README.md | 8 +++++++- 10 files changed, 68 insertions(+), 14 deletions(-) create mode 100644 exercises/if/README.md delete mode 100644 exercises/if/REAMDE.md diff --git a/exercises/functions/REAMDE.md b/exercises/functions/REAMDE.md index 70555a1c..c40755bb 100644 --- a/exercises/functions/REAMDE.md +++ b/exercises/functions/REAMDE.md @@ -1 +1,7 @@ -For this exercise check out the chapter [Functions](https://doc.rust-lang.org/book/2018-edition/ch03-03-how-functions-work.html) of the Rust Book. \ No newline at end of file +### Functions + +Here, you'll learn how to write functions and how Rust's compiler can trace things way back. + +#### Book Sections + +- [How Functions Work](https://doc.rust-lang.org/stable/book/ch03-03-how-functions-work.html) diff --git a/exercises/if/README.md b/exercises/if/README.md new file mode 100644 index 00000000..996ac93a --- /dev/null +++ b/exercises/if/README.md @@ -0,0 +1,7 @@ +### If + +`if`, the most basic type of control flow, is what you'll learn here. + +#### Book Sections + +- [Control Flow - if expressions](https://doc.rust-lang.org/stable/book/ch03-05-control-flow.html#if-expressions) diff --git a/exercises/if/REAMDE.md b/exercises/if/REAMDE.md deleted file mode 100644 index 10614621..00000000 --- a/exercises/if/REAMDE.md +++ /dev/null @@ -1 +0,0 @@ -For this exercise check out the chapter [If](https://doc.rust-lang.org/book/2018-edition/ch03-05-control-flow.html?highlight=control,fl#control-flow) of the Rust Book. \ No newline at end of file diff --git a/exercises/macros/README.md b/exercises/macros/README.md index 87851c59..b8f8e426 100644 --- a/exercises/macros/README.md +++ b/exercises/macros/README.md @@ -1,2 +1,10 @@ -For this exercise check out the section [Macros](https://doc.rust-lang.org/book/2018-edition/macros.html) and the chapter -[Macros Appendix](https://doc.rust-lang.org/book/2018-edition/appendix-04-macros.html) of the Rust Book and [The Little Book of Rust Macros](https://danielkeep.github.io/tlborm/book/index.html). +### Macros + +Rust's macro system is very powerful, but also kind of difficult to wrap your +head around. We're not going to teach you how to write your own fully-featured +modules, instead we'll show you how to use and create them. + +#### Book Sections + +- [Macros](https://doc.rust-lang.org/stable/book/ch19-06-macros.html) +- [The Little Book of Rust Macros](https://danielkeep.github.io/tlborm/book/index.html) diff --git a/exercises/modules/README.md b/exercises/modules/README.md index 7a0232fa..7a58d900 100644 --- a/exercises/modules/README.md +++ b/exercises/modules/README.md @@ -1 +1,7 @@ -For this exercise check out the [Modules](https://doc.rust-lang.org/book/2018-edition/ch07-01-mod-and-the-filesystem.html) chapter of the Rust Book. \ No newline at end of file +### Modules + +In this section we'll give you an introduction to Rust's module system. + +#### Book Sections + +- [The Module System](https://doc.rust-lang.org/stable/book/ch07-02-modules-and-use-to-control-scope-and-privacy.html) diff --git a/exercises/move_semantics/README.md b/exercises/move_semantics/README.md index c8095bfe..1b9cab74 100644 --- a/exercises/move_semantics/README.md +++ b/exercises/move_semantics/README.md @@ -1,7 +1,10 @@ -These exercises are adapted from [pnkfelix](https://github.com/rustlings/rustlings/blob/master)'s [Rust Tutorial](https://pnkfelix.github.io/rust-examples-icfp2014/) -- Thank you Felix!!! +### Move Semantics -For this exercise check out the chapters: -- [Ownership](https://doc.rust-lang.org/book/2018-edition/ch04-01-what-is-ownership.html) -- [Reference and borrowing](https://doc.rust-lang.org/book/2018-edition/ch04-02-references-and-borrowing.html) +These exercises are adapted from [pnkfelix](https://github.com/pnkfelix)'s [Rust Tutorial](https://pnkfelix.github.io/rust-examples-icfp2014/) -- Thank you Felix!!! -of the Rust Book. \ No newline at end of file +#### Book Sections + +For this section, the book links are especially important. + +- [Ownership](https://doc.rust-lang.org/stable/book/ch04-01-what-is-ownership.html) +- [Reference and borrowing](https://doc.rust-lang.org/stable/book/ch04-02-references-and-borrowing.html) diff --git a/exercises/primitive_types/README.md b/exercises/primitive_types/README.md index e4f31810..b53394a2 100644 --- a/exercises/primitive_types/README.md +++ b/exercises/primitive_types/README.md @@ -1 +1,8 @@ -For this exercise check out the chapter [Data Types](https://doc.rust-lang.org/book/2018-edition/ch03-02-data-types.html) of the Rust Book. \ No newline at end of file +### Primitive Types + +Rust has a couple of basic types that are directly implemented into the +compiler. In this section, we'll go through the most important ones. + +#### Book Sections + +- [Data Types](https://doc.rust-lang.org/stable/book/ch03-02-data-types.html) diff --git a/exercises/strings/REAMDE.md b/exercises/strings/REAMDE.md index 76b74d74..b79ac061 100644 --- a/exercises/strings/REAMDE.md +++ b/exercises/strings/REAMDE.md @@ -1 +1,9 @@ -For this exercise check out the chapter [Strings](https://doc.rust-lang.org/book/2018-edition/ch08-02-strings.html) of the Rust Book. \ No newline at end of file +### Strings + +Rust has two string types, a string slice (`&str`) and an owned string (`String`). +We're not going to dictate when you should use which one, but we'll show you how +to identify and create them, as well as use them. + +#### Book Sections + +- [Strings](https://doc.rust-lang.org/stable/book/ch08-02-strings.html) diff --git a/exercises/tests/README.md b/exercises/tests/README.md index 8683ba8a..243b9136 100644 --- a/exercises/tests/README.md +++ b/exercises/tests/README.md @@ -1,3 +1,7 @@ +### Tests + Going out of order from the book to cover tests -- many of the following exercises will ask you to make tests pass! -For this exercise check out the section [How to Write Tests](https://doc.rust-lang.org/book/2018-edition/ch11-01-writing-tests.html) of the Rust Book. \ No newline at end of file +#### Book Sections + +- [Writing Tests](https://doc.rust-lang.org/stable/book/ch11-01-writing-tests.html) diff --git a/exercises/variables/README.md b/exercises/variables/README.md index 574c1621..6ae26cb6 100644 --- a/exercises/variables/README.md +++ b/exercises/variables/README.md @@ -1 +1,7 @@ -For this exercise checkout the section [Variables and Mutability](https://doc.rust-lang.org/book/2018-edition/ch03-01-variables-and-mutability.html) of the Rust Book. \ No newline at end of file +### Variables + +Here you'll learn about simple variables. + +#### Book Sections + +- [Variables and Mutability](https://doc.rust-lang.org/stable/book/ch03-01-variables-and-mutability.html)