diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f7c47686..32e85c7d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,12 +29,13 @@ jobs: rustup default nightly rustup component add rustfmt - - name: Reformat + - name: Format the project run: dprint fmt - - uses: parkerbxyz/suggest-changes@v1 + - name: Add PR suggestions for formatting changes + uses: parkerbxyz/suggest-changes@v1 - - name: Check if there were any changes + - name: Check for changes run: git diff --exit-code typos: diff --git a/README.md b/README.md index 6cf59630..aaaa75cc 100644 --- a/README.md +++ b/README.md @@ -47,15 +47,15 @@ Articles and blog posts from around the web which cover Comprehensive Rust: The course is built using a few tools: -* [mdbook](https://github.com/rust-lang/mdBook) -* [mdbook-svgbob](https://github.com/boozook/mdbook-svgbob) +- [mdbook](https://github.com/rust-lang/mdBook) +- [mdbook-svgbob](https://github.com/boozook/mdbook-svgbob) - [mdbook-i18n-helpers and i18n-report](https://github.com/google/mdbook-i18n-helpers) - [mdbook-exerciser](mdbook-exerciser/) - [mdbook-course](mdbook-course/) In addition, [mdbook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck) checks -the internal links. +the internal links. First install Rust by following the instructions on https://rustup.rs/. Then clone this repository: