summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/lualatex-truncate/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 /macros/luatex/latex/lualatex-truncate/README.md
Initial commit
Diffstat (limited to 'macros/luatex/latex/lualatex-truncate/README.md')
-rw-r--r--macros/luatex/latex/lualatex-truncate/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/macros/luatex/latex/lualatex-truncate/README.md b/macros/luatex/latex/lualatex-truncate/README.md
new file mode 100644
index 0000000000..53de8f0486
--- /dev/null
+++ b/macros/luatex/latex/lualatex-truncate/README.md
@@ -0,0 +1,36 @@
+# lualatex-truncate
+This package provides a wrapper for the [`truncate` package](https://ctan.org/pkg/truncate) package,
+which fixes issues related to LuaTeX's hyphenation algorithm.
+
+
+### Dependencies
+`lualatex-truncate` depends on these packages:
+`iftex`, `letltxmacro` and `truncate`
+
+
+### Installation
+Extract the *package* file first:
+
+ 1. Run LaTeX over the file `lualatex-truncate.ins`
+ 2. Move the resulting `.sty` file to `TEXMF/tex/lualatex/lualatex-truncate/`
+
+Then, you can compile the *documentation* yourself by executing
+
+ lualatex lualatex-truncate-doc.dtx
+ makeindex -s gind.ist lualatex-truncate-doc.idx
+ makeindex -s gglo.ist -o lualatex-truncate-doc.gls lualatex-truncate-doc.glo
+ lualatex lualatex-truncate-doc.dtx
+ lualatex lualatex-truncate-doc.dtx
+
+
+or just use the precompiled documentation shipped with the source files.
+In both cases, copy the files `lualatex-truncate-doc.pdf` and `README.md` to `TEXMF/doc/lualatex/lualatex-truncate/`.
+
+
+
+### License
+LPPL 1.3c or any later version (available at [http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt "Show the current version of the LPPL"))
+
+This package is *maintained*. Current maintainer is [Sebastian Friedl](mailto:sfr682k@t-online.de).
+
+