summaryrefslogtreecommitdiff
path: root/support/texcount/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/texcount/README.md
Initial commit
Diffstat (limited to 'support/texcount/README.md')
-rw-r--r--support/texcount/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/support/texcount/README.md b/support/texcount/README.md
new file mode 100644
index 0000000000..321d09f571
--- /dev/null
+++ b/support/texcount/README.md
@@ -0,0 +1,37 @@
+TeXcount
+========
+
+TeXcount is a Perl script that counts the number of words in the
+text of LaTeX files. It has rules for handling most of the common
+macros and provides colour coded output indicating which parts have
+been counted.
+
+
+# Web site and online web service
+
+Go to
+ http://app.uio.no/ifi/texcount/
+for more information or to access the script online as a web service.
+
+
+# Documentation
+
+There is documentation at different levels of detail and technicality:
+
+* **QuickReference** gives a quick overview of options and TeXcount instructions which may be used to control how TeXcount processes TeX documents.
+
+* **TeXcount** is the main documentation giving a detailed explanation of how TeXcount processes TeX documents, and how to use options and TeXcount instructions to customise the word counting and reporting the results.
+
+* **TechDoc** is the technical documentation of the internals of TeXcount.
+
+Additional documentation, including scripts and examples, are available on the TeXcount web site:
+ http://app.uio.no/ifi/texcount/
+
+Questions posted to StackExchange and tagged *texcount* will automatically notify the TeXcount developer:
+ https://tex.stackexchange.com/questions/tagged/texcount
+
+
+# License
+
+The package, i.e. the script and all accompanying files, is
+distributed under the LaTeX Project Public License.