Clarify the readme a bit

This commit is contained in:
Carol (Nichols || Goulding) 2016-12-01 09:33:09 -05:00
parent 86862b1c71
commit 840cfc8e1c

View File

@ -94,11 +94,11 @@ values that don't cut off the image.
## Spellchecking
To scan source file for spell errors, you can use `spellcheck.sh` script. It
needs a dictionary of valid words, which is provided in `dictionary.txt`. If
script produces a false positive (say, you used word `BTreeMap` which script
considers invalid) you need to add this word to dictionary file (in any place
in the file, but you can keep sorted order for consistency).
To scan source files for spelling errors, you can use the `spellcheck.sh`
script. It needs a dictionary of valid words, which is provided in
`dictionary.txt`. If the script produces a false positive (say, you used word
`BTreeMap` which the script considers invalid), you need to add this word to
`dictionary.txt` (keep the sorted order for consistency).
## Converting Windows newlines to Unix