summaryrefslogtreecommitdiff
path: root/support/optexcount/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-06-22 03:00:55 +0000
committerNorbert Preining <norbert@preining.info>2021-06-22 03:00:55 +0000
commit2a49c67eee870febe71143a093f3c304e0033153 (patch)
treec9806df7138b04732008e0f3ed8aaae00fc2da1b /support/optexcount/README.md
parente5ca43f7439d850f4193a932455792429cff61eb (diff)
CTAN sync 202106220300
Diffstat (limited to 'support/optexcount/README.md')
-rw-r--r--support/optexcount/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/support/optexcount/README.md b/support/optexcount/README.md
new file mode 100644
index 0000000000..ebfcea5b53
--- /dev/null
+++ b/support/optexcount/README.md
@@ -0,0 +1,5 @@
+# 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`