path: root/README
diff options
authorWill Robertson <>2010-05-20 18:36:01 +0930
committerWill Robertson <>2010-05-20 18:36:01 +0930
commit3e48b77d3e17d9efd573b2027656f75acc1983d3 (patch)
tree271316435021267d4cbde437a7cb690f75626dfe /README
parentd02e35c48f51e37eef26929257ba9773c3afde9b (diff)
Attempt to move everything into the README
Have I got the order of the names right? (And are those emails addresses public?) Hope you don't mind moving NEWS into here. (Revert if you like.)
Diffstat (limited to 'README')
1 files changed, 77 insertions, 41 deletions
diff --git a/README b/README
index 9409648..e6a982a 100644
--- a/README
+++ b/README
@@ -1,12 +1,57 @@
- The luaotfload generic package
+ The luaotfload package
+Luaotfload is an adaptation of the ConTeXt font loading system for Plain and
+LaTeX. It allows OpenType fonts to be loaded with OpenType features accessible
+through the XeTeX font syntax.
-luaotfload is the adaptation of the ConTeXt OTF loading system for Plain and
-LaTeX. It allows to open OTF fonts with almost all features available through
-the XeTeX font syntax.
+It may be loaded in Plain LuaTeX with "\input luaotfload.sty" and in LuaLaTeX
+with "\usepackage{luaotfload}". LuaLaTeX users may be interested in the
+fontspec package which provides a high-level interface to the functionality
+provided by this package.
-This package is developed on <>, see the
-'NEWS' file for version history.
+Please see the documentation luaotfload.pdf for more information.
+This package is developed on <>.
+Please report bugs at the Github address above.
+Discussion of development for LuaLaTeX is held in the lualatex-dev mailing
+list. See <> to join or to
+view the archives.
+Responsible Persons
+The following people have contributed to this package.
+Khaled Hosny <>
+Elie Roux <>
+Manuel Pégourié-Gonnard <>
+Will Robertson <>
+(In approximate order of lines of code contributed.)
+Change History
+Currrent git, luaotfload v1.07:
+ * using the new luatexbase package
+ * synchronizing with latest ConTeXt stable 2010.05.08
+ * adding support for microtypography
+ * adding support for color and transparency
+ * adding a script to generate a font database with TeX and system fonts
+ * more verbose log file
+2010/02/07, luaotfload v1.06a:
+ * more complete tlig and trep
+ * defaults options changed to "+ccmp;+locl;+rlig;+liga;+clig;+kern;
+ +mark;+mkmk;"
+ * supporting windows absolute path
+2009/12/01, luaotfload v1.06:
+ * synchronizing with ConTeXt stable 2009.11.26
+ * adding backward compatibility with LuaTeX 0.40.6
@@ -17,10 +62,10 @@ Here are the recommended installation methods (preferred first).
1. If you are using TeX Live 2008 or later, use 'tlmgr install luaotfload'.
Alternatively, try your (TeX or Linux) distribution's package management system.
-2. a. Grab on the CTAN.
+2. a. Download from CTAN.
b. Unzip it at the root of one or your TDS trees.
c. You may need to update some filename database after, see your TeX
-distribution's manual for details.
+ distribution's manual for details.
3. a. Grab the sources from CTAN or github.
b. Run 'make install TEXMFROOT=/path/to/texmf'.
@@ -32,6 +77,8 @@ distribution's manual for details.
+The following files are part of the luaotfload package.
Source files:
luaotfload.dtx single file source & doc for the package
mkluatexfontdb.lua script using otfl-font-nms.lua
@@ -66,28 +113,15 @@ Derived files:
luaotfload.sty TeX & LaTeX package
luaotfload.lua Lua code for the package
-This work is distributed under the GNU GPLv2 license. Please see COPYING file
-for more details about the license.
-The files otfl-*.lua are under the GNU GPLv2 license. Their legal notice
-starts by:
+The luaotfload bundle is distributed under the GNU GPLv2 license:
+ <>
+This license requires the license itself to be distributed with the work.
+It may be located within the documentation luaotfload.pdf.
-Copyright 2008 PRAGMA ADE / ConTeXt Development Team
-for otf-*.lua files except otfl-font-clr.lua and otfl-luat-ovr.lua, and
-Copyright 2010 Luaotfload Development Team
-for otfl-font-clr.lua, otfl-font-nms and otfl-luat-ovr.lua, and continues by:
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
@@ -98,22 +132,24 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
GNU General Public License for more details.
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+All non-ConTeXt source files in this bundle,
+ luaotfload.dtx
+ mkluatexfontdb.lua
+ otfl-data-con.lua
+ otfl-font-clr.lua
+ otfl-luat-ovr.lua
+ otfl-luat-nms.lua
+and derived files
+ luaotfload.pdf
+ luaotfload.sty
+ luaotfload.lua
+are copyright 2010 by the luaotfload development team (see above).
+These files may be modified and distributed under the terms and conditions
+of the CC0 license: <>
-The file luaotfload.dtx and the derived files
- luaotfload.pdf
- luaotfload.sty
- luaotfload.lua
-as well as the file mkluatexfontdb.lua are under the CC0 license. You can find
-the CC0 license full text at
+The ConTeXt files otfl-*.lua (as indicated above) are distributed under the
+terms and conditions of the GNU GPLv2 license. These contents of these files
+is copyright 2008 by PRAGMA ADE and the ConTeXt Development Team.
-and a FAQ at