summaryrefslogtreecommitdiff
path: root/texmf-dist/doc/generic/harftex/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'texmf-dist/doc/generic/harftex/README.md')
-rw-r--r--texmf-dist/doc/generic/harftex/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/texmf-dist/doc/generic/harftex/README.md b/texmf-dist/doc/generic/harftex/README.md
new file mode 100644
index 00000000..d18fc126
--- /dev/null
+++ b/texmf-dist/doc/generic/harftex/README.md
@@ -0,0 +1,22 @@
+Harf
+====
+
+A [HarfBuzz][harfbuzz]-based font loader and shaper for [HarfTeX][harftex].
+
+History
+-------
+
+The initial version of the shaping code was inspired by [luatex-harfbuzz] but was
+completely rewritten to use new HarfBuzz APIs and features and be independent
+from luaotfload/ConTeXt.
+
+There are few other projects for using HarfBuzz with LuaTeX:
+* [luatex-harfbuzz]: Can access HarfBuzz through FFI, SWIG or use the luaharfbuzz module.
+* [luatex-harfbuzz-shaper]: Uses luaharfbuzz module
+* [ufylayout]: A Lua module that uses luaharfbuzz and provides BiDi support as well.
+
+[harfbuzz]: https://github.com/harfbuzz/harfbuzz
+[harftex]: https://github.com/khaledhosny/harftex
+[luatex-harfbuzz]: https://github.com/tatzetwerk/luatex-harfbuzz
+[luatex-harfbuzz-shaper]: https://github.com/michal-h21/luatex-harfbuzz-shaper
+[ufylayout]: https://github.com/ufyTeX/ufylayout