diff options
Diffstat (limited to 'support/optexcount/README.md')
-rw-r--r-- | support/optexcount/README.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/support/optexcount/README.md b/support/optexcount/README.md index ebfcea5b53..70d104c414 100644 --- a/support/optexcount/README.md +++ b/support/optexcount/README.md @@ -1,5 +1,7 @@ # OpTeXcount What is OpTeXcount? It is a basic python script that analyzes OpTeX source code and counts words in specific categories. For more information about this tool read `optexcount-doc.pdf`. -### How to use it? -Run: `python3 optexcount.py filename [-verbose] [-set-verbchar=verb-char]`, where `filename` is the name of our OpTeX code file. What does the optional argument `-verbose`? It prints the entire source code with colored words according to their categories. `-set-verbchar=verb-char` sets the implicit inline verbatim character to `verb-char` +### How to install OpTeXcount? +Run: `sudo ./install.sh` +### Usage +Run: `optexcount [-h] [-v] [-s SET_VERBCHAR] [--version] filename`, where `filename` is the name of our OpTeX code file. What does the optional argument `-v/--verbose`? It prints the entire source code with colored words according to their categories. `-s SET_VERBCHAR` or `--set-verbchar SET_VERBCHAR` sets the implicit inline verbatim character to `SET_VERBCHAR` character. |