summaryrefslogtreecommitdiff
path: root/README
blob: 01e1fc6025ee5cbc44e5a00ff6c077ccf24f8ad8 (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
*******************************************************************************
                            The Luaotfload Package
*******************************************************************************

Luaotfload is an adaptation of the ConTeXt font loading system for the Plain
and LaTeX formats. It allows OpenType fonts to be loaded with font features
accessible using an extended font request syntax while providing compatibility
with XeTeX. By indexing metadata in a database it facilitates loading fonts by
their proper names instead of file names.

Luaotfload 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.

Please see the documentation luaotfload.pdf for more information.

This package is developed by the LuaLaTeX dev team on
<http://github.com/lualatex/luaotfload>. Please report bugs to the issue
tracker there.

The development for LuaLaTeX is discussed on the lualatex-dev mailing list. See
<http://www.tug.org/mailman/listinfo/lualatex-dev> for details.


Responsible Persons
-------------------------------------------------------------------------------
The following people have contributed to this package.

Khaled Hosny             <khaledhosny@eglug.org>
Elie Roux                <elie.roux@telecom-bretagne.eu>
Will Robertson           <will.robertson@latex-project.org>
Philipp Gesang           <phg@phi-gamma.net>
Dohyun Kim               <nomosnomos@gmail.com>
Reuben Thomas            <https://github.com/rrthomas>
Joseph Wright            <joseph.wright@morningstar2.co.uk>
Manuel Pégourié-Gonnard  <mpg@elzevir.fr>
Olof-Joachim Frahm       <olof@macrolet.net>
Patrick Gundlach         <gundlach@speedata.de>
Philipp Stephani         <st_philipp@yahoo.de>
David Carlisle           <d.p.carlisle@gmail.com>


Installation
-------------------------------------------------------------------------------

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. Download luaotfload.tds.zip 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.

3. a. Grab the sources from CTAN or github.
   b. Run 'make install TEXMFROOT=/path/to/texmf'.
   c. See 2c.

4. Try to figure it out by looking at the Makefile and comments in the sources.

Prerequisites
-------------------------------------------------------------------------------

You need GNU make to use the Makefile. The executable may be called "gmake" on
your system.

Typesetting the documentation requires LuaTeX and GraphViz. The Docutils are
needed to generate the manpage.

License
-------------------------------------------------------------------------------

The luaotfload bundle, as a derived work of ConTeXt, is distributed under the
GNU GPLv2 license:

   <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>

This license requires the license itself to be distributed with the work. For
its full text see the documentation in luaotfload.pdf.


                                  DISCLAIMER

        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; version 2.

        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.

        See headers of each source file for copyright details.