Add dependencies, instructions for configuring project_path

master
Marc Hiatt 2 years ago
parent de1d337d5d
commit fa9b91d644
  1. 15
      README.md

@ -11,11 +11,15 @@ This package includes two shell scripts: `worddiv`, which is written to be POSIX
## installation and configuration ##
0. worddiv assumes you have working copies of TeX and LaTeX on your system. Type `tex -version` and `latex -version` to check if this is the case.
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.
2. Adjust `project_path` variable.
The script hardcodes a location where it will temporarily store some data that it needs. The script’s variable `project_path` thus needs to point to an existing directory. For worddiv to work, you’ll probably need to alter the value of that variable.
If using `worddiv.fish`, you need to alter the value (the path) assigned by the line beginning:
If you intend to use `worddiv.fish`, you’ll first need to edit that file to alter the value (the path) assigned by the line beginning:
set -f project_path
@ -23,9 +27,12 @@ If using the POSIX-compatible `worddiv`, the line you’ll want to alter is the
project_path=
3. Make sure the package location is in your $PATH.
In either case, the value you assign can be the directory where your clone of the repo resides, or it can be some other directory (e.g. `/tmp`).
## usage ##
3. Ensure the package location is in your $PATH.
## usage ##
Call the script. Then type a word to see its hyphenation patterns. Where

Loading…
Cancel
Save