diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..c579725 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,*.lock,.codespellrc +check-hidden = true +# ignore-regex = +# ignore-words-list = diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..c59e047 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/README.md b/README.md index 412e131..8458f06 100644 --- a/README.md +++ b/README.md @@ -266,7 +266,7 @@ your cards for you. ### SSD Read Speed Requirements -Here's the sequential read speeds you'll need to benchmark specific resoultion & fps combos. If your SSD is not fast +Here's the sequential read speeds you'll need to benchmark specific resolution & fps combos. If your SSD is not fast enough, your maximum fps scores will be lower due to i/o bottlenecking. ```text @@ -315,7 +315,7 @@ you're more than welcome to use other IDE's. It's suggested that you setup automatic formatting in RustRover to avoid the `rustfmt` job failing and blocking your PR. Go to Settings -> Languages and Frameworks -> Rust -> Rustfmt, and -enable `Use Rustfmt instead of the build-in formatter` and `Run Rustfmt automatically on Save`. +enable `Use Rustfmt instead of the built-in formatter` and `Run Rustfmt automatically on Save`. ![rustrover-rustfmt.png](docs%2Frustrover-rustfmt.png)