Skip to content

Commit c33114a

Browse files
kytpbsRahix
authored andcommitted
Fix typos and improve wording in README.md
1 parent 6807aaf commit c33114a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ avr-hal ![Continuous Integration](https://github.com/Rahix/avr-hal/workflows/Con
33
Hardware Abstraction Layer for AVR microcontrollers and common boards (for example Arduino). Based on the [`avr-device`](https://github.com/Rahix/avr-device) crate.
44

55
## Quickstart
6-
You need a nightly Rust compiler for compiling Rust code for AVR. The correct version will be installed automatically due to the `rust-toolchain.toml` file.
6+
You need a nightly Rust compiler for compiling Rust code for AVR. The correct version will be installed automatically thanks to the `rust-toolchain.toml` file.
77

88
Install dependencies:
99

@@ -23,7 +23,7 @@ Install dependencies:
2323
```
2424
winget install AVRDudes.AVRDUDE ZakKemble.avr-gcc
2525
```
26-
On older systems you can use [Scoop](https://scoop.sh/) which you first have to install using Powershell:
26+
On older systems, you can use [Scoop](https://scoop.sh/) which you first have to install using PowerShell:
2727
```PowerShell
2828
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser # Needed to run a remote script the first time
2929
irm get.scoop.sh | iex
@@ -35,7 +35,7 @@ Install dependencies:
3535
```
3636
See [Setting up environment](https://github.com/Rahix/avr-hal/wiki/Setting-up-environment) for more information.
3737

38-
Next, install ["ravedude"](./ravedude), a tool which seamlessly integrates flashing your board into the usual cargo workflow:
38+
Next, install ["ravedude"](./ravedude), a tool that seamlessly integrates flashing your board into the usual cargo workflow:
3939

4040
```bash
4141
cargo +stable install ravedude
@@ -71,7 +71,7 @@ The [examples directory](./examples) contains lots of examples for common hardwa
7171
HAL crates for AVR microcontroller families. If you have a custom board, you'll want to work with these crates. Please check their documentation for a list of supported MCUs.
7272

7373
### `avr-hal-generic` [![avr-hal-generic docs](https://img.shields.io/badge/docs-git-4d76ae)][avr-hal-generic docs]
74-
This is a generic crate containing most of the HAL implementations in the form of macros which are instanciated in each HAL crate for the specific MCUs. If you intend to write drivers that work with any AVR chip, targeting `avr-hal-generic` is probably the best route.
74+
This is a generic crate containing most of the HAL implementations in the form of macros which are instantiated in each HAL crate for the specific MCUs. If you intend to write drivers that work with any AVR chip, targeting `avr-hal-generic` is probably the best route.
7575

7676
### [`ravedude`](./ravedude) [![crates.io page](https://img.shields.io/crates/v/ravedude.svg)](https://crates.io/crates/ravedude)
7777
`ravedude` is a utility for seamlessly integrating avrdude and a serial console into the cargo workflow. With a bit of configuration (check its [README](./ravedude/README.md)!) you can then upload your code to your board and view its output over the serial console by just using `cargo run` as you would normally.

0 commit comments

Comments
 (0)