Skip to content

Commit 9e656ea

Browse files
bors[bot]Niederb
andcommitted
Merge #174
174: Small text changes r=therealprof a=Niederb Some small changes I did while reading. Feel fee to incorporate what you like and discard the rest. Co-authored-by: Thomas Niederberger <thomas@niederb.ch>
2 parents 2503da4 + 133f4f0 commit 9e656ea

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

src/intro/hardware.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ What does this board contain?
1818

1919
- 48 KiB of RAM.
2020

21-
- Many integrated peripherals such as timers, I2C, SPI and USART.
21+
- A variety of integrated peripherals such as timers, I2C, SPI and USART.
2222

2323
- General purpose Input Output (GPIO) and other types of pins accessible through the two rows of headers along side the board.
2424

@@ -34,6 +34,6 @@ What does this board contain?
3434

3535
- A second microcontroller: a [STM32F103](https://www.st.com/en/microcontrollers/stm32f103cb.html). This microcontroller is actually part of an on-board programmer / debugger and is connected to the USB port named "USB ST-LINK".
3636

37-
For a more detailed features list and further specification of the board take a look at [STMicroelectronics](https://www.st.com/en/evaluation-tools/stm32f3discovery.html) website.
37+
For a more detailed list of features and further specifications of the board take a look at the [STMicroelectronics](https://www.st.com/en/evaluation-tools/stm32f3discovery.html) website.
3838

39-
A word of warning: be careful if you want to apply external signals to the board. The microcontroller STM32F303VCT6 pins take a nominal voltage of 3.3 volts. For further information consult the [6.2 Absolute maximum ratings section in the manual](https://www.st.com/resource/en/datasheet/stm32f303vc.pdf)
39+
A word of caution: be careful if you want to apply external signals to the board. The microcontroller STM32F303VCT6 pins take a nominal voltage of 3.3 volts. For further information consult the [6.2 Absolute maximum ratings section in the manual](https://www.st.com/resource/en/datasheet/stm32f303vc.pdf)

src/intro/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome to The Embedded Rust Book: An introductory book about using the Rust
44
Programming Language on "Bare Metal" embedded systems, such as Microcontrollers.
55

66
## Who Embedded Rust is For
7-
Embedded Rust is for everyone who wants to do embedded programming backed by the higher-level concepts and safety guarantees the Rust language provides.
7+
Embedded Rust is for everyone who wants to do embedded programming while taking advantage of the higher-level concepts and safety guarantees the Rust language provides.
88
(See also [Who Rust Is For](https://doc.rust-lang.org/book/2018-edition/ch00-00-introduction.html))
99

1010
## Scope
@@ -23,16 +23,16 @@ The goals of this book are:
2323

2424
This book tries to be as general as possible but to make things easier for both
2525
the readers and the writers it uses the ARM Cortex-M architecture in all its
26-
examples. However, the book assumes that the reader is not familiar with this
26+
examples. However, the book doesn't assume that the reader is familiar with this
2727
particular architecture and explains details particular to this architecture
2828
where required.
2929

3030
## Who This Book is For
31-
This book caters towards people with either some embedded background or some Rust background, however we assume
31+
This book caters towards people with either some embedded background or some Rust background, however we believe
3232
everybody curious about embedded Rust programming can get something out of this book. For those without any prior knowledge
3333
we suggest you read the "Assumptions and Prerequisites" section and catch up on missing knowledge to get more out of the book
3434
and improve your reading experience. You can check out the "Other Resources" section to find resources on topics
35-
you want to catch up on.
35+
you might want to catch up on.
3636

3737
### Assumptions and Prerequisites
3838

@@ -72,7 +72,7 @@ not dig into details on a topic, revisiting the topic in a later chapter.
7272
This book will be using the [STM32F3DISCOVERY] development board from
7373
STMicroelectronics for the majority of the examples contained within. This board
7474
is based on the ARM Cortex-M architecture, and while basic functionality is
75-
common across most CPUs based on this architecture, peripherals and other
75+
the same across most CPUs based on this architecture, peripherals and other
7676
implementation details of Microcontrollers are different between different
7777
vendors, and often even different between Microcontroller families from the same
7878
vendor.

src/intro/no-std.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are two general Embedded Programming classifications:
1111

1212
## Hosted Environments
1313
These kinds of environments are close to a normal PC environment.
14-
What this means is you are provided with a System Interface [E.G. POSIX](https://en.wikipedia.org/wiki/POSIX)
14+
What this means is that you are provided with a System Interface [E.G. POSIX](https://en.wikipedia.org/wiki/POSIX)
1515
that provides you with primitives to interact with various systems, such as file systems, networking, memory management, threads, etc.
1616
Standard libraries in turn usually depend on these primitives to implement their functionality.
1717
You may also have some sort of sysroot and restrictions on RAM/ROM-usage, and perhaps some

src/intro/tooling.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ can be found on the next page.
2424
## `cargo-generate` OR `git`
2525

2626
Bare metal programs are non-standard (`no_std`) Rust programs that require some
27-
fiddling with the linking process to get the memory layout of the program
28-
right. All this requires unusual files (like linker scripts) and unusual
29-
settings (like linker flags). We have packaged all that for you in a template
30-
so that you only need to fill in the blanks such as the project name and the
31-
characteristics of your target hardware.
27+
adjustments to the linking process in order to get the memory layout of the program
28+
right. This requires some additional files (like linker scripts) and
29+
settings (like linker flags). We have packaged those for you in a template
30+
such that you only need to fill in the missing information (such as the project name and the
31+
characteristics of your target hardware).
3232

3333
Our template is compatible with `cargo-generate`: a Cargo subcommand for
3434
creating new Cargo projects from templates. You can also download the
@@ -57,7 +57,7 @@ can follow some parts of this book even if you don't have any hardware with you!
5757

5858
A debugger is a very important component of embedded development as you may not
5959
always have the luxury to log stuff to the host console. In some cases, you may
60-
not have LEDs to blink on your hardware!
60+
not even have LEDs to blink on your hardware!
6161

6262
In general, LLDB works as well as GDB when it comes to debugging but we haven't
6363
found an LLDB counterpart to GDB's `load` command, which uploads the program to

src/start/qemu.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ the tooling and the development process.
77

88
[LM3S6965]: http://www.ti.com/product/LM3S6965
99

10-
## A non standard Rust program
10+
## Creating a non standard Rust program
1111

12-
We'll use the [`cortex-m-quickstart`] project template so go generate a new
12+
We'll use the [`cortex-m-quickstart`] project template to generate a new
1313
project from it.
1414

1515
[`cortex-m-quickstart`]: https://github.com/rust-embedded/cortex-m-quickstart
@@ -73,7 +73,7 @@ $ mv cortex-m-quickstart-master app
7373
$ cd app
7474
```
7575

76-
OR you can browse to [`cortex-m-quickstart`], click the green "Clone or
76+
Or you can browse to [`cortex-m-quickstart`], click the green "Clone or
7777
download" button and then click "Download ZIP".
7878

7979
Then fill in the placeholders in the `Cargo.toml` file as done in the second

0 commit comments

Comments
 (0)