Anurag Thakur pushed to branch gsoc-anurag-docs-2023 at FreeType / FreeType
Commits:
-
0ca54477
by Anurag Thakur at 2023-06-29T20:39:22+05:30
-
5a60d2ef
by Anurag Thakur at 2023-06-29T21:44:10+05:30
9 changed files:
- README.md
- docs/.gitignore
- docs/INSTALL → docs/INSTALL.md
- docs/INSTALL.ANY → docs/INSTALL_ANY.md
- docs/INSTALL.CROSS → docs/INSTALL_CROSS.md
- docs/INSTALL.GNU → docs/INSTALL_GNU.md
- docs/INSTALL.MAC → docs/INSTALL_MAC.md
- docs/INSTALL.UNIX → docs/INSTALL_UNIX.md
- docs/INSTALL.VMS → docs/INSTALL_VMS.md
Changes:
... | ... | @@ -154,7 +154,7 @@ and accept it fully. |
154 | 154 | [Documentation GZ]: https://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.gz
|
155 | 155 | [Documentation ZIP]: https://download.savannah.gnu.org/releases/freetype/ftdmo2111.zip
|
156 | 156 | |
157 | -[INSTALL]: ./docs/INSTALL
|
|
157 | +[INSTALL]: ./docs/INSTALL.md
|
|
158 | 158 | [CHANGES]: ./docs/CHANGES
|
159 | 159 | [LICENSE]: ./LICENSE.TXT
|
160 | 160 | [DOCGUIDE]: ./docs/DOCGUIDE
|
... | ... | @@ -5,6 +5,14 @@ reference/ |
5 | 5 | *.html
|
6 | 6 | *.md
|
7 | 7 | |
8 | +!INSTALL.md
|
|
9 | +!INSTALL_ANY.md
|
|
10 | +!INSTALL_CROSS.md
|
|
11 | +!INSTALL_GNU.md
|
|
12 | +!INSTALL_MAC.md
|
|
13 | +!INSTALL_UNIX.md
|
|
14 | +!INSTALL_VMS.md
|
|
15 | + |
|
8 | 16 | # MkDocs Config file
|
9 | 17 | mkdocs.yml
|
10 | 18 |
1 | +# Building FreeType
|
|
1 | 2 | |
2 | 3 | There are several ways to build the FreeType library, depending on
|
3 | 4 | your system and the level of customization you need. Here is a short
|
4 | 5 | overview of the documentation available:
|
5 | 6 | |
6 | 7 | |
7 | -I. Prerequisites and dependencies
|
|
8 | -=================================
|
|
8 | +## A. Prerequisites and dependencies
|
|
9 | 9 | |
10 | 10 | FreeType is a low level C library that only depends on the standard
|
11 | 11 | C library with very few platform-dependent optimizations utilized at
|
... | ... | @@ -24,23 +24,22 @@ I. Prerequisites and dependencies |
24 | 24 | run-time; look at the documentation of function `FT_Property_Set`.
|
25 | 25 | |
26 | 26 | |
27 | -II. Normal installation and upgrades
|
|
28 | -====================================
|
|
27 | +## B. Normal installation and upgrades
|
|
29 | 28 | |
30 | - 1. Unix and Unix-like systems
|
|
29 | +1. Unix and Unix-like systems
|
|
31 | 30 | |
32 | 31 | This also includes MacOS, Cygwin, MinGW + MSYS, Mingw-w64 + MSYS2,
|
33 | 32 | and possibly other, similar environments.
|
34 | 33 | |
35 | - Please read `INSTALL.UNIX` to install or upgrade FreeType 2 on a
|
|
34 | + Please read [INSTALL.UNIX] to install or upgrade FreeType 2 on a
|
|
36 | 35 | Unix system. Note that you *need* GNU Make for automatic
|
37 | 36 | compilation, since other make tools won't work (this includes BSD
|
38 | 37 | Make).
|
39 | 38 | |
40 | - GNU Make VERSION 3.81 OR NEWER IS NEEDED!
|
|
39 | + **GNU Make VERSION 3.81 OR NEWER IS NEEDED!**
|
|
41 | 40 | |
42 | 41 | |
43 | - 2. Other systems using GNU Make
|
|
42 | +2. Other systems using GNU Make
|
|
44 | 43 | |
45 | 44 | On some non-Unix platforms, it is possible to build the library
|
46 | 45 | using only the GNU Make utility. Note that *NO OTHER MAKE TOOL
|
... | ... | @@ -48,22 +47,24 @@ II. Normal installation and upgrades |
48 | 47 | Windows, OS/2, and BeOS, including MinGW* (without MSYS*), Visual
|
49 | 48 | C++, Borland C++, and more.
|
50 | 49 | |
51 | - Instructions are provided in the file `INSTALL.GNU`.
|
|
50 | + Instructions are provided in the file [INSTALL.GNU].
|
|
52 | 51 | |
53 | 52 | |
54 | - 3. Other build tools and platforms.
|
|
53 | +3. Other build tools and platforms.
|
|
55 | 54 | |
56 | 55 | A few other tools can be used to build FreeType. You can find
|
57 | 56 | the corresponding instruction files in the FreeType root folder
|
58 | 57 | or the builds/ sub-folder.
|
59 | 58 | |
60 | - CMake :: see `CMakeLists.txt` for more information
|
|
61 | - Meson :: see `meson.build` for more information
|
|
62 | - MSBuild :: see `builds/windows/vc2010/freetype.vcxproj`
|
|
63 | - MMS :: see `vms_make.com` and `docs/INSTALL.VMS`
|
|
59 | + |Build Tool | Details |
|
|
60 | + | --- | --- |
|
|
61 | + |CMake | see [CMakeLists.txt] for more information |
|
|
62 | + |Meson | see [meson.build] for more information |
|
|
63 | + |MSBuild | see [freetype.vcxproj] |
|
|
64 | + |MMS | see [vms_make.com] and [INSTALL.VMS] |
|
|
64 | 65 | |
65 | 66 | |
66 | - 4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
|
|
67 | +4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
|
|
67 | 68 | |
68 | 69 | We provide a small number of 'project files' for various IDEs to
|
69 | 70 | automatically build the library as well. Note that these files
|
... | ... | @@ -74,22 +75,63 @@ II. Normal installation and upgrades |
74 | 75 | directory, where <system> stands for your OS or environment.
|
75 | 76 | |
76 | 77 | |
77 | - 5. From you own IDE, or own Makefiles
|
|
78 | +5. From you own IDE, or own Makefiles
|
|
78 | 79 | |
79 | 80 | If you want to create your own project file, follow the
|
80 | - instructions given in the `INSTALL.ANY` document of this
|
|
81 | + instructions given in the [INSTALL.ANY] document of this
|
|
81 | 82 | directory.
|
82 | 83 | |
83 | 84 | |
84 | -III. Custom builds of the library
|
|
85 | -=================================
|
|
85 | +## C. Custom builds of the library
|
|
86 | 86 | |
87 | 87 | Customizing the compilation of FreeType is easy, and allows you to
|
88 | 88 | select only the components of the font engine that you really need.
|
89 | - For more details read the file `CUSTOMIZE`.
|
|
89 | + For more details read the file [docs/CUSTOMIZE][CUSTOMIZE].
|
|
90 | 90 | |
91 | +## D. Standard builds with `configure`
|
|
91 | 92 | |
92 | -----------------------------------------------------------------------
|
|
93 | + The git repository doesn't contain pre-built configuration scripts for
|
|
94 | + UNIXish platforms. To generate them say
|
|
95 | + |
|
96 | + sh autogen.sh
|
|
97 | + |
|
98 | + which in turn depends on the following packages:
|
|
99 | + |
|
100 | + automake (1.10.1)
|
|
101 | + libtool (2.2.4)
|
|
102 | + autoconf (2.62)
|
|
103 | + |
|
104 | + The versions given in parentheses are known to work. Newer versions
|
|
105 | + should work too, of course. Note that `autogen.sh` also sets up
|
|
106 | + proper file permissions for the `configure` and auxiliary scripts.
|
|
107 | + |
|
108 | + The `autogen.sh` script checks whether the versions of the above three
|
|
109 | + tools match the numbers above. Otherwise it will complain and suggest
|
|
110 | + either upgrading or using environment variables to point to more
|
|
111 | + recent versions of the required tools.
|
|
112 | + |
|
113 | + Note that `aclocal` is provided by the 'automake' package on Linux,
|
|
114 | + and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
|
|
115 | + |
|
116 | + |
|
117 | +## E. Alternative build methods
|
|
118 | + |
|
119 | + For static builds that don't use platform-specific optimizations, no
|
|
120 | + configure script is necessary at all; saying
|
|
121 | + |
|
122 | + make setup ansi
|
|
123 | + make
|
|
124 | + |
|
125 | + should work on all platforms that have GNU `make` (or `makepp`).
|
|
126 | + |
|
127 | + A build with `cmake` or `meson` can be done directly from the git
|
|
128 | + repository. However, if you want to use the `FT_DEBUG_LOGGING` macro
|
|
129 | + (see file [docs/DEBUG][DEBUG] for more information) it is currently mandatory
|
|
130 | + to execute `autogen.sh` in advance; this script clones the 'dlg' git
|
|
131 | + submodule and copies some files into FreeType's source tree.
|
|
132 | + |
|
133 | + |
|
134 | +---
|
|
93 | 135 | |
94 | 136 | [1] make++, a make tool written in Perl, has sufficient support of GNU
|
95 | 137 | make extensions to build FreeType. See
|
... | ... | @@ -99,7 +141,7 @@ III. Custom builds of the library |
99 | 141 | for more information; you need version 2.0 or newer, and you must
|
100 | 142 | pass option `--norc-substitution`.
|
101 | 143 | |
102 | -----------------------------------------------------------------------
|
|
144 | +---
|
|
103 | 145 | |
104 | 146 | Copyright (C) 2000-2023 by
|
105 | 147 | David Turner, Robert Wilhelm, and Werner Lemberg.
|
... | ... | @@ -110,5 +152,15 @@ license, LICENSE.TXT. By continuing to use, modify, or distribute |
110 | 152 | this file you indicate that you have read the license and understand
|
111 | 153 | and accept it fully.
|
112 | 154 | |
113 | - |
|
114 | ---- end of INSTALL --- |
|
155 | +<!----------------------------------------------------------------------------->
|
|
156 | + |
|
157 | +[CMakeLists.txt]: ../CMakeLists.txt
|
|
158 | +[meson.build]: ../meson.build
|
|
159 | +[freetype.vcxproj]: ../builds/windows/vc2010/freetype.vcxproj
|
|
160 | +[vms_make.com]: ../vms_make.com
|
|
161 | +[INSTALL.VMS]: ./INSTALL.VMS
|
|
162 | +[INSTALL.ANY]: ./INSTALL.ANY
|
|
163 | +[INSTALL.GNU]: ./INSTALL.GNU
|
|
164 | +[INSTALL.UNIX]: ./INSTALL.UNIX
|
|
165 | +[CUSTOMIZE]: ./CUSTOMIZE
|
|
166 | +[DEBUG]: ./DEBUG |
1 | -Instructions on how to build FreeType with your own build tool
|
|
2 | -==============================================================
|
|
1 | +# Instructions on how to build FreeType with your own build tool
|
|
3 | 2 | |
4 | -See the file `CUSTOMIZE' to learn how to customize FreeType to
|
|
5 | -specific environments.
|
|
6 | 3 | |
4 | +See the file [docs/CUSTOMIZE][CUSTOMIZE] to learn how to
|
|
5 | +customize FreeType to specific environments.
|
|
7 | 6 | |
8 | -I. Standard procedure
|
|
9 | ----------------------
|
|
10 | 7 | |
11 | - * If you use macro names for FreeType header files (while mandatory
|
|
12 | - in earlier versions, this is now optional since FreeType version
|
|
13 | - 2.6.1) it is necessary to disable pre-compiled headers. This is
|
|
14 | - very important for Visual C++, because lines like
|
|
8 | +## A. Standard procedure
|
|
9 | + |
|
10 | +* If you use macro names for FreeType header files (while mandatory
|
|
11 | + in earlier versions, this is now optional since FreeType version
|
|
12 | + 2.6.1) it is necessary to disable pre-compiled headers. This is
|
|
13 | + very important for Visual C++, because lines like
|
|
15 | 14 | |
16 | 15 | #include FT_FREETYPE_H
|
17 | 16 | |
18 | - are not correctly supported by this compiler while being ISO C
|
|
19 | - compliant!
|
|
17 | + are not correctly supported by this compiler while being ISO C
|
|
18 | + compliant!
|
|
20 | 19 | |
21 | - * You need to add the directory `include' to your include path when
|
|
22 | - compiling the library.
|
|
20 | +* You need to add the directory `include` to your include path when
|
|
21 | + compiling the library.
|
|
23 | 22 | |
24 | - * FreeType 2 is made of several components; each of them is located
|
|
25 | - in a subdirectory of `freetype/src'. For example,
|
|
26 | - `freetype/src/truetype/' contains the TrueType font driver.
|
|
23 | +* FreeType 2 is made of several components; each of them is located
|
|
24 | + in a subdirectory of `freetype/src`. For example,
|
|
25 | + `freetype/src/truetype/` contains the TrueType font driver.
|
|
27 | 26 | |
28 | - * DO NOT COMPILE ALL C FILES! Rather, compile the following ones.
|
|
27 | +* DO NOT COMPILE ALL C FILES! Rather, compile the following ones.
|
|
29 | 28 | |
30 | - -- base components (required)
|
|
29 | + ### base components (required):
|
|
31 | 30 | |
32 | 31 | src/base/ftsystem.c
|
33 | 32 | src/base/ftinit.c
|
... | ... | @@ -55,7 +54,7 @@ I. Standard procedure |
55 | 54 | |
56 | 55 | src/base/ftmac.c -- only on the Macintosh
|
57 | 56 | |
58 | - -- font drivers (optional; at least one is needed)
|
|
57 | + ### font drivers (optional; at least one is needed)
|
|
59 | 58 | |
60 | 59 | src/bdf/bdf.c -- BDF font driver
|
61 | 60 | src/cff/cff.c -- CFF/OpenType font driver
|
... | ... | @@ -69,14 +68,13 @@ I. Standard procedure |
69 | 68 | src/type42/type42.c -- Type 42 font driver
|
70 | 69 | src/winfonts/winfnt.c -- Windows FONT / FNT font driver
|
71 | 70 | |
72 | - -- rasterizers (optional; at least one is needed for vector
|
|
73 | - formats)
|
|
71 | + ### rasterizers (optional; at least one is needed for vector formats)
|
|
74 | 72 | |
75 | 73 | src/raster/raster.c -- monochrome rasterizer
|
76 | 74 | src/sdf/sdf.c -- Signed Distance Field driver
|
77 | 75 | src/smooth/smooth.c -- anti-aliasing rasterizer
|
78 | 76 | |
79 | - -- auxiliary modules (optional)
|
|
77 | + ### auxiliary modules (optional)
|
|
80 | 78 | |
81 | 79 | src/autofit/autofit.c -- auto hinting module
|
82 | 80 | src/cache/ftcache.c -- cache sub-system (in beta)
|
... | ... | @@ -90,54 +88,53 @@ I. Standard procedure |
90 | 88 | src/psnames/psnames.c -- PostScript glyph names support
|
91 | 89 | |
92 | 90 | |
93 | - Notes:
|
|
91 | + ## Notes:
|
|
94 | 92 | |
95 | - `ftcache.c' needs `ftglyph.c'
|
|
96 | - `ftfstype.c' needs `fttype1.c'
|
|
97 | - `ftglyph.c' needs `ftbitmap.c'
|
|
98 | - `ftstroke.c' needs `ftglyph.c'
|
|
99 | - `ftsynth.c' needs `ftbitmap.c'
|
|
93 | + `ftcache.c` needs `ftglyph.c`
|
|
94 | + `ftfstype.c` needs `fttype1.c`
|
|
95 | + `ftglyph.c` needs `ftbitmap.c`
|
|
96 | + `ftstroke.c` needs `ftglyph.c`
|
|
97 | + `ftsynth.c` needs `ftbitmap.c`
|
|
100 | 98 | |
101 | - `cff.c' needs `sfnt.c', `pshinter.c', and `psnames.c'
|
|
102 | - `truetype.c' needs `sfnt.c' and `psnames.c'
|
|
103 | - `type1.c' needs `psaux.c' `pshinter.c', and `psnames.c'
|
|
104 | - `type1cid.c' needs `psaux.c', `pshinter.c', and `psnames.c'
|
|
105 | - `type42.c' needs `truetype.c'
|
|
99 | + `cff.c` needs `sfnt.c`, `pshinter.c`, and `psnames.c`
|
|
100 | + `truetype.c` needs `sfnt.c` and `psnames.c`
|
|
101 | + `type1.c` needs `psaux.c` `pshinter.c`, and `psnames.c`
|
|
102 | + `type1cid.c` needs `psaux.c`, `pshinter.c`, and `psnames.c`
|
|
103 | + `type42.c` needs `truetype.c`
|
|
106 | 104 | |
107 | - Please consult the central `include/freetype/config/ftoption.h'
|
|
108 | - configuration file for details on additional libraries necessary
|
|
109 | - for some optional features.
|
|
105 | + Please consult the central `include/freetype/config/ftoption.h`
|
|
106 | + configuration file for details on additional libraries necessary
|
|
107 | + for some optional features.
|
|
110 | 108 | |
111 | 109 | |
112 | - Read the file `CUSTOMIZE' in case you want to compile only a subset
|
|
113 | - of the drivers, renderers, and optional modules; a detailed
|
|
114 | - description of the various base extension is given in the top-level
|
|
115 | - file `modules.cfg'.
|
|
110 | +Read the file `CUSTOMIZE` in case you want to compile only a subset
|
|
111 | +of the drivers, renderers, and optional modules; a detailed
|
|
112 | +description of the various base extension is given in the top-level
|
|
113 | +file `modules.cfg`.
|
|
116 | 114 | |
117 | - You are done. In case of problems, see the archives of the FreeType
|
|
118 | - development mailing list.
|
|
115 | +You are done. In case of problems, see the archives of the FreeType
|
|
116 | +development mailing list.
|
|
119 | 117 | |
120 | 118 | |
121 | -II. Support for flat-directory compilation
|
|
122 | -------------------------------------------
|
|
119 | +## B. Support for flat-directory compilation
|
|
123 | 120 | |
124 | - It is possible to put all FreeType 2 source files into a single
|
|
125 | - directory, with the *exception* of the `include' hierarchy.
|
|
121 | +It is possible to put all FreeType 2 source files into a single
|
|
122 | +directory, with the *exception* of the `include` hierarchy.
|
|
126 | 123 | |
127 | - 1. Copy all files in current directory
|
|
124 | +1. Copy all files in current directory
|
|
128 | 125 | |
129 | - cp freetype/src/base/*.[hc] .
|
|
130 | - cp freetype/src/raster1/*.[hc] .
|
|
131 | - cp freetype/src/smooth/*.[hc] .
|
|
132 | - etc.
|
|
126 | + cp freetype/src/base/*.[hc] .
|
|
127 | + cp freetype/src/raster1/*.[hc] .
|
|
128 | + cp freetype/src/smooth/*.[hc] .
|
|
129 | + etc.
|
|
133 | 130 | |
134 | - 2. Compile sources
|
|
131 | +2. Compile sources
|
|
135 | 132 | |
136 | - cc -c -Iinclude -DFT2_BUILD_LIBRARY ftsystem.c
|
|
137 | - cc -c -Iinclude -DFT2_BUILD_LIBRARY ftinit.c
|
|
138 | - cc -c -Iinclude -DFT2_BUILD_LIBRARY ftdebug.c
|
|
139 | - cc -c -Iinclude -DFT2_BUILD_LIBRARY ftbase.c
|
|
140 | - etc.
|
|
133 | + cc -c -Iinclude -DFT2_BUILD_LIBRARY ftsystem.c
|
|
134 | + cc -c -Iinclude -DFT2_BUILD_LIBRARY ftinit.c
|
|
135 | + cc -c -Iinclude -DFT2_BUILD_LIBRARY ftdebug.c
|
|
136 | + cc -c -Iinclude -DFT2_BUILD_LIBRARY ftbase.c
|
|
137 | + etc.
|
|
141 | 138 | |
142 | 139 | You don't need to define the FT_FLAT_COMPILATION macro (as this
|
143 | 140 | was required in previous releases of FreeType 2).
|
... | ... | @@ -154,4 +151,5 @@ this file you indicate that you have read the license and understand |
154 | 151 | and accept it fully.
|
155 | 152 | |
156 | 153 | |
157 | ---- end of INSTALL.ANY --- |
|
154 | +<!---->
|
|
155 | +[CUSTOMIZE]: ./CUSTOMIZE |
1 | -This document contains instructions on how to build the FreeType
|
|
2 | -library on Unix systems. This also works for emulations like Cygwin
|
|
3 | -or MSys on Win32:
|
|
1 | +# Building FreeType on Unix Systems
|
|
4 | 2 | |
3 | +This also works for emulations like Cygwin or MSys on Win32:
|
|
5 | 4 | |
6 | - 1. Ensure that you are using GNU Make
|
|
7 | - -------------------------------------
|
|
5 | + |
|
6 | +1. **Ensure that you are using GNU Make**
|
|
8 | 7 | |
9 | 8 | The FreeType build system _exclusively_ works with GNU Make. You
|
10 | 9 | will not be able to compile the library with the instructions
|
11 | 10 | below using any other alternative (including BSD Make).
|
12 | 11 | |
13 | 12 | Check that you have GNU make by running the command:
|
14 | - |
|
15 | - make -v
|
|
13 | + ```bash
|
|
14 | + make -v
|
|
15 | + ```
|
|
16 | 16 | |
17 | 17 | This should dump some text that begins with:
|
18 | 18 | |
19 | - GNU Make <version number>
|
|
20 | - Copyright (C) <year> Free Software Foundation Inc.
|
|
19 | + GNU Make <version number>
|
|
20 | + Copyright (C) <year> Free Software Foundation Inc.
|
|
21 | 21 | |
22 | 22 | Note that version 3.81 or higher is *required* or the build will
|
23 | 23 | fail.
|
... | ... | @@ -26,102 +26,104 @@ or MSys on Win32: |
26 | 26 | if you use the MAKE variable as described below.
|
27 | 27 | |
28 | 28 | As a special exception, 'makepp' can also be used to build
|
29 | - FreeType 2. See the file docs/MAKEPP for details.
|
|
29 | + FreeType 2. See the file `docs/MAKEPP` for details.
|
|
30 | 30 | |
31 | - For builds with `cmake' please check file `CMakeLists.txt'; this
|
|
31 | + For builds with `cmake` please check file `CMakeLists.txt`; this
|
|
32 | 32 | is a contributed file not directly supported by the FreeType team.
|
33 | 33 | |
34 | 34 | |
35 | - 2. Regenerate the configure script if needed
|
|
36 | - --------------------------------------------
|
|
35 | +2. **Regenerate the configure script if needed**
|
|
37 | 36 | |
38 | 37 | This only applies if you are building a git snapshot or checkout,
|
39 | 38 | *not* if you grabbed the sources of an official release.
|
40 | 39 | |
41 | - You need to invoke the `autogen.sh' script in the top-level
|
|
42 | - directory in order to create the `configure' script for your
|
|
40 | + You need to invoke the `autogen.sh` script in the top-level
|
|
41 | + directory in order to create the `configure` script for your
|
|
43 | 42 | platform. Normally, this simply means typing:
|
44 | - |
|
45 | - sh autogen.sh
|
|
43 | + ```bash
|
|
44 | + sh autogen.sh
|
|
45 | + ```
|
|
46 | 46 | |
47 | 47 | In case of problems, you may need to install or upgrade Automake,
|
48 | - Autoconf or Libtool. See `README.git' in the top-level directory
|
|
49 | - for more information.
|
|
48 | + Autoconf or Libtool. See [INSTALL.md] for more information.
|
|
50 | 49 | |
51 | 50 | |
52 | - 3. Build and install the library
|
|
53 | - --------------------------------
|
|
51 | +3. **Build and install the library**
|
|
54 | 52 | |
55 | 53 | Say
|
56 | - |
|
57 | - ./configure --help
|
|
54 | + ```bash
|
|
55 | + ./configure --help
|
|
56 | + ```
|
|
58 | 57 | |
59 | 58 | to see the list of possible configuration options and important
|
60 | - environment variables. The ./configure script will detect some
|
|
59 | + environment variables. The `./configure` script will detect some
|
|
61 | 60 | prerequisite system libraries (libpng, brotli, etc.) if their
|
62 | 61 | headers are available at the default locations.
|
63 | 62 | |
64 | - The following should work on all Unix systems where the `make'
|
|
63 | + The following should work on all Unix systems where the `make`
|
|
65 | 64 | command invokes GNU Make:
|
66 | - |
|
67 | - ./configure [options]
|
|
68 | - make
|
|
69 | - make install (as root)
|
|
70 | - |
|
71 | - The default installation path is `/usr/local'. It can be changed
|
|
72 | - with the `--prefix=<path>' option. Example:
|
|
73 | - |
|
74 | - ./configure --prefix=/usr
|
|
65 | + ```bash
|
|
66 | + ./configure [options]
|
|
67 | + make
|
|
68 | + make install (as root)
|
|
69 | + ```
|
|
70 | + |
|
71 | + The default installation path is `/usr/local`. It can be changed
|
|
72 | + with the `--prefix=<path>` option. Example:
|
|
73 | + ```bash
|
|
74 | + ./configure --prefix=/usr
|
|
75 | + ```
|
|
75 | 76 | |
76 | 77 | When using a different command to invoke GNU Make, use the MAKE
|
77 | - variable. For example, if `gmake' is the command to use on your
|
|
78 | + variable. For example, if `gmake` is the command to use on your
|
|
78 | 79 | system, do something like:
|
79 | - |
|
80 | - MAKE=gmake ./configure [options]
|
|
81 | - gmake
|
|
82 | - gmake install (as root)
|
|
80 | + ```bash
|
|
81 | + MAKE=gmake ./configure [options]
|
|
82 | + gmake
|
|
83 | + gmake install (as root)
|
|
84 | + ```
|
|
83 | 85 | |
84 | 86 | If this still doesn't work, there must be a problem with your
|
85 | 87 | system (e.g., you are using a very old version of GNU Make).
|
86 | 88 | |
87 | - For library identification, FreeType's `configure' script uses the
|
|
88 | - `pkg-config' interface: Assuming it needs library `foo', it calls
|
|
89 | - the `pkg-config' program to find information on library `foo',
|
|
90 | - which in turn looks for a `foo.pc' file installed at the system.
|
|
91 | - Some platforms, however, don't come with `pkg-support'; you then
|
|
89 | + For library identification, FreeType's `configure` script uses the
|
|
90 | + `pkg-config` interface: Assuming it needs library `foo`, it calls
|
|
91 | + the `pkg-config` program to find information on library `foo`,
|
|
92 | + which in turn looks for a `foo.pc` file installed at the system.
|
|
93 | + Some platforms, however, don't come with `pkg-support`; you then
|
|
92 | 94 | have to use environment variables as described by `configure
|
93 | - --help'. Example:
|
|
94 | - |
|
95 | - LIBPNG_CFLAGS="-I/path/to/libpng/include/directory" \
|
|
96 | - LIBPNG_LIBS="-L/path/to/libpng/lib/directory" \
|
|
97 | - configure ...
|
|
98 | - |
|
95 | + --help`. Example:
|
|
96 | + ```bash
|
|
97 | + LIBPNG_CFLAGS="-I/path/to/libpng/include/directory" \
|
|
98 | + LIBPNG_LIBS="-L/path/to/libpng/lib/directory" \
|
|
99 | + configure ...
|
|
100 | + ```
|
|
99 | 101 | It is possible to compile FreeType in a different directory.
|
100 | - Assuming the FreeType source files in directory `/src/freetype' a
|
|
101 | - compilation in directory `foo' works as follows:
|
|
102 | - |
|
103 | - cd foo
|
|
104 | - /src/freetype/configure [options]
|
|
105 | - make
|
|
106 | - make install
|
|
102 | + Assuming the FreeType source files in directory `/src/freetype` a
|
|
103 | + compilation in directory `foo` works as follows:
|
|
104 | + ```bash
|
|
105 | + cd foo
|
|
106 | + /src/freetype/configure [options]
|
|
107 | + make
|
|
108 | + make install
|
|
109 | + ```
|
|
107 | 110 | |
108 | 111 | |
109 | - 3.1 Interdependency with HarfBuzz
|
|
110 | - .................................
|
|
112 | +3.1 **Interdependency with HarfBuzz**
|
|
111 | 113 | |
112 | - Note that there is a chicken-and-egg problem currently since the
|
|
113 | - HarfBuzz library (used by the auto-hinter to improve support of
|
|
114 | - OpenType fonts) depends on FreeType, which can be solved as
|
|
115 | - follows in case HarfBuzz is not yet installed on your system.
|
|
114 | + Note that there is a chicken-and-egg problem currently since the
|
|
115 | + HarfBuzz library (used by the auto-hinter to improve support of
|
|
116 | + OpenType fonts) depends on FreeType, which can be solved as
|
|
117 | + follows in case HarfBuzz is not yet installed on your system.
|
|
116 | 118 | |
117 | - 1. Call FreeType's `configure' script with option
|
|
118 | - `--without-harfbuzz', then compile and install FreeType.
|
|
119 | + 1. Call FreeType's `configure` script with option
|
|
120 | + `--without-harfbuzz`, then compile and install FreeType.
|
|
119 | 121 | |
120 | - 2. Compile and install HarfBuzz.
|
|
122 | + 2. Compile and install HarfBuzz.
|
|
121 | 123 | |
122 | - 3. Call FreeType's `configure' script without option
|
|
123 | - `--without-harfbuzz' (after executing `make distclean'), then
|
|
124 | - compile and install FreeType again.
|
|
124 | + 3. Call FreeType's `configure` script without option
|
|
125 | + `--without-harfbuzz` (after executing `make distclean`), then
|
|
126 | + compile and install FreeType again.
|
|
125 | 127 | |
126 | 128 | |
127 | 129 | ----------------------------------------------------------------------
|
... | ... | @@ -135,5 +137,5 @@ license, LICENSE.TXT. By continuing to use, modify, or distribute |
135 | 137 | this file you indicate that you have read the license and understand
|
136 | 138 | and accept it fully.
|
137 | 139 | |
138 | - |
|
139 | ---- end of INSTALL.UNIX --- |
|
140 | +<!---->
|
|
141 | +[INSTALL.md]: ./INSTALL.md |