Skip to content

Commit 321a503

Browse files
authored
Merge pull request #221 from Sh3Rm4n/fix-markdown-lint
Fix markdown lint check
2 parents 31ca8a3 + 7878eed commit 321a503

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,12 @@ jobs:
148148
name: Markdown Lint
149149
runs-on: ubuntu-latest
150150
steps:
151+
- uses: actions/checkout@v2
151152
- uses: nosborn/[email protected]
152153
with:
153154
files: .
154-
ignore_files: "target/"
155+
config_file: .markdownlint.yml
156+
ignore_files: target/
155157

156158
link-checker:
157159
name: Link Checker

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,16 @@ compile with older versions but that may change in any new patch release.
170170

171171
### Running Tests
172172

173-
Tests are run via the integration test pattern and are executed on a target chip, rather than on a host system.
174-
First, install [probe-run](https://crates.io/crates/probe-run) via `cargo install probe-run`.
175-
Next, you'll need to modify `.cargo/config` to link defmt and use `probe-run` configured for your chip.
176-
See details within the comments in that file.
173+
Tests are run via the integration test pattern and are executed on a target
174+
chip, rather than on a host system. First, install
175+
[probe-run](https://crates.io/crates/probe-run) via `cargo install probe-run`.
176+
Next, you'll need to modify `.cargo/config` to link defmt and use `probe-run`
177+
configured for your chip. See details within the comments in that file.
177178

178-
Now, you can execute a test by setting your device, defmt, and any test specific features:
179+
Now, you can execute a test by setting your device, defmt, and any test specific
180+
features:
179181

180-
```
182+
```bash
181183
cargo test --test rcc --features=stm32f303xc,defmt,rt
182184
```
183185

0 commit comments

Comments
 (0)