Skip to content

Commit

Permalink
readme: cspell command
Browse files Browse the repository at this point in the history
Signed-off-by: Ethan Perruzza <[email protected]>
  • Loading branch information
EthanPERRUZZA committed Jan 30, 2025
1 parent 0ecec11 commit 706082d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ docker run --rm -it \
./hugo.sh
```

## Spell Checker

```
cspell --config cspell/cspell.json
```

If you need to use a specific word that isn't in the dictionaries, you can add it to the correct `.txt` dictionary in the `cspell` folder.

## Contributing

If you think OSRD doesn't quite fit your needs yet, but still believe it could,
Expand All @@ -53,4 +61,4 @@ For more information on how to contribute, check out the [Contributing file](./C

## Get in touch

Send an email at <[email protected]>, [open an issue](https://github.com/OpenRailAssociation/osrd-website/issues/new), or join the [#public-general:osrd.fr](https://matrix.to/#/#public-general:osrd.fr) matrix channel.
Send an email at <[email protected]>, [open an issue](https://github.com/OpenRailAssociation/osrd-website/issues/new), or join the [#public-general:osrd.fr](https://matrix.to/#/#public-general:osrd.fr) matrix channel.

0 comments on commit 706082d

Please sign in to comment.