summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/optexcount/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/optexcount/README.md')
-rw-r--r--Master/texmf-dist/doc/support/optexcount/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/optexcount/README.md b/Master/texmf-dist/doc/support/optexcount/README.md
new file mode 100644
index 00000000000..70d104c414e
--- /dev/null
+++ b/Master/texmf-dist/doc/support/optexcount/README.md
@@ -0,0 +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 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.