summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/lua-uni-algos/README.md
blob: 9409918ab903edf00a3a84f6399fca7db25f9e96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# The lua-uni-algos Package

Version: v0.2

Date: 2020-05-17

Author: Marcel Krüger

License: LPPL v1.3c

A collection of small Lua modules implementing some if the most generic Unicode algorithms for use with LuaTeX.
This package tries to reduce duplicated work by collecting a set of small utilities which can be used be useful for many LuaTeX packages dealing with Unicode strings.
There is no user-level functionality provided.

Additional Unicode algorithms will be added in the future, if you need a specific algorithm feel free to open an issue on GitHub or send me an e-mail.


## Requirements

Given that this package provides Lua modules, it is only useful in Lua(HB)TeX.
Additionally, it expects an up-to-date version of the `unicode-data` package to be present.


## Support
If you found a bug, please open an [issue on GitHub](https://github.com/zauguin/lua-uni-algos/issues) or contact me by mail at <tex@2krueger.de>.

## Installation

In most cases it is best to use an official release provided by your TeX distribution.
If you want to install an experimental build directly from the repository, use `l3build install`.