diff --git a/README.md b/README.md index e1e0e0a50..d4d18a0ee 100644 --- a/README.md +++ b/README.md @@ -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, @@ -53,4 +61,4 @@ For more information on how to contribute, check out the [Contributing file](./C ## Get in touch -Send an email at , [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. \ No newline at end of file +Send an email at , [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.