@ -6,9 +6,24 @@ The LaTeX typesetting software includes high quality dictionaries of word divisi
worddiv is a simple script that makes it convenient to query the LaTeX word division dictionary interactively using a terminal emulator. This can help, for example, when proofreading galleys that do not adhere to the word hyphenations presented in an approriate high quality dictionary.
This package includes two shell scripts: `worddiv`, which is written to be POSIX-compatible, and `worddiv.fish`, written in `fish`. Take your pick.
## installation ##
## installation and configuration ##
1. Clone the worddiv repo.
2. The scripts hardcode locations for cached files that are needed for worddiv to work: a directory for temporary files that is itself located (in the author’s personal file system) in the project path where the package resides. You should alter the project path to point to an existing directory in your own file system.
If using `worddiv.fish`, you need to alter the value (the path) assigned by the line beginning:
set -f project_path
If using the POSIX-compatible `worddiv`, the line you’ll want to alter is the one beginning
project_path=
3. Make sure the package location is in your $PATH.