Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added FAQ entry to ignore words #100

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,22 @@ Please set `g:grammarous#show_first_error` to `1`. It opens an information windo
Please set `g:grammarous#use_location_list` to `1`. It sets all grammatical errors to location list.
This variable is set to `0` by default to avoid conflicts of location list usage with other plugins.

### I want to ignore words

Edit the `ignore.txt` file corresponding to your language. The files for
languages are located in the hunspell directory of the LanguageTool
installation.

`path/to/vim-grammarous/misc/LanguageTool-stable/LanguageTool-5.4/org/languagetool/resource/LANGUAGECODE/hunspell/ignore.txt`

For example to ignore words when checking German (de) text:

`path/to/vim-grammarous/misc/LanguageTool-stable/LanguageTool-5.4/org/languagetool/resource/de/hunspell/ignore.txt`

Add the words you want to ignore to the `ignore.txt` file and save. When the
grammar checker is executed again, these words do not show up as errors
anymore.

## Automatic installation

This plugin attempts to install [LanguageTool](https://www.languagetool.org/) using `curl` or `wget` command at first time.
Expand Down