summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/lua-typo/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-03-05 03:00:50 +0000
committerNorbert Preining <norbert@preining.info>2021-03-05 03:00:50 +0000
commitceb2b4332d87ef96a7c9e20b61a2ac9c9e524690 (patch)
tree0e7c043d4f54d89e524c093d81b68a1f765c6bd5 /macros/luatex/latex/lua-typo/README.md
parent467737fbb47c40688b7e8548099b6236b4196d6d (diff)
CTAN sync 202103050300
Diffstat (limited to 'macros/luatex/latex/lua-typo/README.md')
-rw-r--r--macros/luatex/latex/lua-typo/README.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/macros/luatex/latex/lua-typo/README.md b/macros/luatex/latex/lua-typo/README.md
new file mode 100644
index 0000000000..29db098d3b
--- /dev/null
+++ b/macros/luatex/latex/lua-typo/README.md
@@ -0,0 +1,55 @@
+Lua-typo
+========
+
+Description
+-----------
+This package tracks common typographic flaws in LuaLaTeX documents,
+specially widows, orphans, hyphenated words split over two pages,
+consecutive lines ending with hyphens, paragraphs ending on
+too short lines, etc.
+
+Documentation
+-------------
+
+For the impatient: have a look at files demo.tex and demo.pdf to see
+a short example of how some flaws are highlighted.
+
+Then read the documentation in English (file lua-typo.pdf) or in French
+(file lua-typo-fr.pdf).
+
+License
+-------
+
+Released under the LaTeX Project Public License v1.3 or later
+See http://www.latex-project.org/lppl.txt
+for the details of that license.
+
+Installation
+------------
+
+This bundle is meant to be included in most TeX distributions,
+but if you need to install it by yourself
+1. run "luatex lua-typo.dtx" to strip the comments and create
+ lua-typo.sty, lua-typo.cfg, lua-typo.ltx and lua-typo-fr.ltx;
+2. run "lualatex lua-typo.ltx" to get the full documentation
+ (lua-typo.pdf) in English;
+2. run "lualatex lua-typo-fr.ltx" to get the French documentation
+ (lua-typo-fr.pdf, code not included).
+
+Recommended loactions for installation:
+- TDS:tex/lualatex/lua-typo/lua-typo.sty
+- TDS:tex/lualatex/lua-typo/lua-typo.cfg
+- TDS:doc/lualatex/lua-typo/lua-typo.pdf
+- TDS:doc/lualatex/lua-typo/demo.pdf
+- TDS:doc/lualatex/lua-typo/demo.tex
+- TDS:doc/lualatex/lua-typo/README.md
+- TDS:source/lualatex/lua-typo/lua-typo.dtx
+
+Changes
+-------
+
+- First release version: 0.30, March 2021.
+
+--
+Copyright 2020--2021 Daniel Flipo
+E-mail: daniel (dot) flipo (at) free (dot) fr