Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / freetype / c09a90a2f16023db0167f95919865ca59770c939 / . / docs / INSTALL
blob: 193c5300a26101d899630e9da5e628c796509420 [file] [log] [blame]
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]1
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]2There are several ways to build the FreeType library, depending on
3your system and the level of customization you need. Here is a short
Werner Lemberga16c4a72003-04-21 13:30:27 +0000[diff] [blame]4overview of the documentation available:
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]5
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]6
Werner Lemberga16c4a72003-04-21 13:30:27 +0000[diff] [blame]7I. Normal installation and upgrades
8===================================
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]9
Werner Lemberg6bbbbc12010-07-04 07:37:56 +0200[diff] [blame]10 1. Unix Systems (including Mac OS X, Cygwin, and MSys on Windows)
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]11
Werner Lembergc3fb9812011-08-16 16:04:33 +0200[diff] [blame]12 Please read `INSTALL.UNIX' to install or upgrade FreeType 2 on a
13 Unix system. Note that you *need* GNU Make for automatic
14 compilation, since other make tools won't work (this includes BSD
15 Make).
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]16
Werner Lemberg293a8772008-08-05 18:36:15 +0000[diff] [blame]17 GNU Make VERSION 3.80 OR NEWER IS NEEDED!
18
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]19
Werner Lemberg6bbbbc12010-07-04 07:37:56 +0200[diff] [blame]20 2. On VMS with the `mms' build tool
Werner Lemberg9b774e22007-01-16 06:11:27 +0000[diff] [blame]21
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]22 See `INSTALL.VMS' for installation instructions on this platform.
23
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]24
Werner Lemberg6bbbbc12010-07-04 07:37:56 +0200[diff] [blame]25 3. Other systems using GNU Make
Werner Lemberg9b774e22007-01-16 06:11:27 +0000[diff] [blame]26
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]27 On non-Unix platforms, it is possible to build the library using
Werner Lemberg6bbbbc12010-07-04 07:37:56 +0200[diff] [blame]28 GNU Make utility. Note that *NO OTHER MAKE TOOL WILL WORK*[1]!
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]29 This methods supports several compilers on Windows, OS/2, and
30 BeOS, including MinGW, Visual C++, Borland C++, and more.
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]31
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]32 Instructions are provided in the file `INSTALL.GNU'.
David Turnerc3c7e7f2000-03-13 14:19:31 +0000[diff] [blame]33
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]34
Werner Lemberg6bbbbc12010-07-04 07:37:56 +0200[diff] [blame]35 4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
Werner Lemberg9b774e22007-01-16 06:11:27 +0000[diff] [blame]36
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]37 We provide a small number of `project files' for various IDEs to
38 automatically build the library as well. Note that these files
39 are not supported and only sporadically maintained by FreeType
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]40 developers, so don't expect them to work in each release.
Werner Lemberg9b774e22007-01-16 06:11:27 +0000[diff] [blame]41
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]42 To find them, have a look at the content of the `builds/<system>'
David Turner66cbc202003-03-20 07:04:40 +0000[diff] [blame]43 directory, where <system> stands for your OS or environment.
Werner Lemberg3975e2e2002-01-09 21:01:18 +0000[diff] [blame]44
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]45
Werner Lemberg994a8592013-10-24 08:50:34 +0200[diff] [blame]46 5. Using cmake
47
48 See the top-level `CMakeLists.txt' file for more information.
49
50
51 6. From you own IDE, or own Makefiles
Werner Lemberg9b774e22007-01-16 06:11:27 +0000[diff] [blame]52
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]53 If you want to create your own project file, follow the
54 instructions given in the `INSTALL.ANY' document of this
55 directory.
David Turner7da48242001-12-11 13:14:41 +0000[diff] [blame]56
57
Werner Lemberga16c4a72003-04-21 13:30:27 +0000[diff] [blame]58II. Custom builds of the library
59================================
David Turner7da48242001-12-11 13:14:41 +0000[diff] [blame]60
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]61 Customizing the compilation of FreeType is easy, and allows you to
62 select only the components of the font engine that you really need.
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]63 For more details read the file `CUSTOMIZE'.
David Turner7da48242001-12-11 13:14:41 +0000[diff] [blame]64
65
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]66----------------------------------------------------------------------
David Turner7da48242001-12-11 13:14:41 +0000[diff] [blame]67
Werner Lemberg6bbbbc12010-07-04 07:37:56 +0200[diff] [blame]68[1] make++, a make tool written in Perl, has sufficient support of GNU
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]69 make extensions to build FreeType. See
70
71 http://makepp.sourceforge.net
72
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]73 for more information; you need version 1.19 or newer, and you must
Werner Lemberga7235262005-08-30 00:22:46 +0000[diff] [blame]74 pass option `--norc-substitution'.
David Turner7da48242001-12-11 13:14:41 +0000[diff] [blame]75
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]76----------------------------------------------------------------------
Werner Lemberg56c368c2005-06-04 23:00:25 +0000[diff] [blame]77
Werner Lembergf57fc592015-01-17 20:41:43 +0100[diff] [blame]78Copyright 2000-2015 by
Werner Lembergf796cf62015-01-17 20:11:10 +0100[diff] [blame]79David Turner, Robert Wilhelm, and Werner Lemberg.
Werner Lemberg56c368c2005-06-04 23:00:25 +0000[diff] [blame]80
Werner Lemberg59939242006-01-31 20:17:42 +0000[diff] [blame]81This file is part of the FreeType project, and may only be used,
82modified, and distributed under the terms of the FreeType project
83license, LICENSE.TXT. By continuing to use, modify, or distribute
84this file you indicate that you have read the license and understand
85and accept it fully.
Werner Lemberg56c368c2005-06-04 23:00:25 +0000[diff] [blame]86
87
Werner Lemberga16c4a72003-04-21 13:30:27 +0000[diff] [blame]88--- end of INSTALL ---