diff --git a/README.md b/README.md index b581ff79..08299d26 100644 --- a/README.md +++ b/README.md @@ -104,36 +104,42 @@ search_dirs = [] extra_dictonaries = [] ``` +To increase verbosity use `CARGO_SPELLCHECK=cargo_spellcheck=trace` to see internal details or +add `-v` (multiple) to increase verbosity. + ## Installation `cargo install cargo-spellcheck` -To increase verbosity use `CARGO_SPELLCHECK=cargo_spellcheck=trace` to see internal details or -add `-v` (multiple) to increase verbosity. +### Checkers -### Hunspell +Available checker support -Requires the native library +#### Hunspell -```sh -# Fedora 30+ -dnf install -y hunspell-devel clang +Requires a C++ compiler to compile the hunspell CXX source files which are part of `hunspell-sys` -# Ubuntu 19.10+ -apt install -y libhunspell-dev clang +##### Fedora 30+ +```sh +dnf install -y clang +``` -# Mac OS X -brew install hunspell llvm +##### Ubuntu 19.10+ +```sh +apt install -y clang ``` -and building should succeed just fine. +##### Mac OS X +``` +brew install llvm +``` -On macOS, set `llvm-config` executable path to `LLVM_CONFIG_PATH` environment variable. +The environment variable `LLVM_CONFIG_PATH` needs to point to `llvm-config`, to do so: -``` -LLVM_CONFIG_PATH=/usr/local/opt/llvm/bin/llvm-config cargo install cargo-spellcheck +```sh +export LLVM_CONFIG_PATH=/usr/local/opt/llvm/bin/llvm-config ``` -### LanguageTool +#### LanguageTool Run a instance of the [LanguageTool server i.e. as container](https://hub.docker.com/r/erikvl87/languagetool).