Skip to content

Commit c9ff6a5

Browse files
committed
add codespell linters
1 parent 46f52d7 commit c9ff6a5

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

.github/workflows/ci_tests.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ jobs:
110110
- name: Setup Macos
111111
if: startsWith(matrix.platform.os, 'macos')
112112
run: sudo chmod -R 777 /opt/
113-
- name: Print installed softwares
113+
- name: Print installed software
114114
shell: bash
115115
run: |
116116
echo "Build system:"
@@ -158,7 +158,7 @@ jobs:
158158
with:
159159
cmakeVersion: "~3.25.0"
160160
ninjaVersion: "^1.11.1"
161-
- name: Print installed softwares
161+
- name: Print installed software
162162
run: |
163163
cmake --version
164164
ninja --version

.pre-commit-config.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,8 @@ repos:
3131
rev: v0.42.0
3232
hooks:
3333
- id: markdownlint
34+
35+
- repo: https://github.com/codespell-project/codespell
36+
rev: v2.3.0
37+
hooks:
38+
- id: codespell

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ This project officially supports:
138138
This project supports [GitHub Codespace](https://github.com/features/codespaces)
139139
via [Development Containers](https://containers.dev/),
140140
which allows rapid development and instant hacking in your browser.
141-
We recommand you using GitHub codespace to explore this project as this
141+
We recommend you using GitHub codespace to explore this project as this
142142
requires minimal setup.
143143
144144
You can create a codespace for this project by clicking this badge:
@@ -164,7 +164,7 @@ we advice you download CMake directly from [CMake's website](https://cmake.org/d
164164
or install via the [Kitware apt library](https://apt.kitware.com/).
165165
166166
A [supported compiler](#supported-platforms) should be available from your package manager.
167-
Alternatively you could use an install script from official compiler venders.
167+
Alternatively you could use an install script from official compiler vendors.
168168
169169
Here is an example of how to install the latest stable version of clang
170170
as per [the official LLVM install guide](https://apt.llvm.org/).
@@ -197,7 +197,7 @@ brew install llvm
197197

198198
### Configure and Build the project using CMake Preset
199199

200-
This project recommands using [CMake Preset](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html)
200+
This project recommends using [CMake Preset](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html)
201201
to configure, build and test the project.
202202
Appropriate presets for major compilers has been included by default.
203203
You can use `cmake --list-presets` to see all available presets.
@@ -216,7 +216,7 @@ thus it has as much sanitizers turned on as possible.
216216
> [!NOTE]
217217
>
218218
> The set of sanitizer supports are different across compilers,
219-
> you can checout the exact set compiler arguments by looking at the toolchain
219+
> you can checkout the exact set compiler arguments by looking at the toolchain
220220
> files under the [`cmake`](cmake/) directory.
221221
222222
The `release` presets are designed for use in production environments,
@@ -225,7 +225,7 @@ thus it has the highest optimization turned on (e.g. `O3`).
225225
### Configure and Build the project manually
226226

227227
While [CMake Preset](#configure-and-build-the-project-using-cmake-preset) is
228-
convient,
228+
convenient,
229229
you might want to pass extra config/ compiler arguments for configuration.
230230

231231
To configure, build and test the project with extra arguments,
@@ -287,7 +287,7 @@ Enable building examples. Default: ON. Values: { ON, OFF }.
287287
## Integrate beman.exemplar into your project
288288

289289
To use `beman.exemplar` in your C++ project,
290-
you should include relavent headers from `beman.exemplar` in your source files.
290+
you should include relevant headers from `beman.exemplar` in your source files.
291291

292292
```c++
293293
#include <beman/exemplar/identity.hpp>

0 commit comments

Comments
 (0)