INSTALL 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. There are several ways to build the FreeType library, depending on
  2. your system and the level of customization you need. Here is a short
  3. overview of the documentation available:
  4. I. Prerequisites and dependencies
  5. =================================
  6. FreeType is a low level C library that only depends on the standard
  7. C library with very few platform-dependent optimizations utilized at
  8. build time. Any C99-compliant compiler should be able to compile
  9. FreeType. System libraries, such as zlib, Gzip, bzip2, Brotli,
  10. and libpng, might be used to handle compressed fonts or decode
  11. embedded PNG glyphs.
  12. FreeType auto-configuration scripts should be able to detect the
  13. prerequisites if the necessary headers are available at the default
  14. locations. Otherwise, modify `include/freetype/config/ftoption.h`
  15. to control how the FreeType library gets built. Normally, you don't
  16. need to change anything.
  17. Applications have very limited control over FreeType's behaviour at
  18. run-time; look at the documentation of function `FT_Property_Set`.
  19. II. Normal installation and upgrades
  20. ====================================
  21. 1. Unix and Unix-like systems
  22. This also includes MacOS, Cygwin, MinGW + MSYS, Mingw-w64 + MSYS2,
  23. and possibly other, similar environments.
  24. Please read `INSTALL.UNIX` to install or upgrade FreeType 2 on a
  25. Unix system. Note that you *need* GNU Make for automatic
  26. compilation, since other make tools won't work (this includes BSD
  27. Make).
  28. GNU Make VERSION 3.81 OR NEWER IS NEEDED!
  29. 2. Other systems using GNU Make
  30. On some non-Unix platforms, it is possible to build the library
  31. using only the GNU Make utility. Note that *NO OTHER MAKE TOOL
  32. WILL WORK*[1]! This methods supports several compilers on
  33. Windows, OS/2, and BeOS, including MinGW* (without MSYS*), Visual
  34. C++, Borland C++, and more.
  35. Instructions are provided in the file `INSTALL.GNU`.
  36. 3. Other build tools and platforms.
  37. A few other tools can be used to build FreeType. You can find
  38. the corresponding instruction files in the FreeType root folder
  39. or the builds/ sub-folder.
  40. CMake :: see `CMakeLists.txt` for more information
  41. Meson :: see `meson.build` for more information
  42. MSBuild :: see `builds/windows/vc2010/freetype.vcxproj`
  43. MMS :: see `vms_make.com` and `docs/INSTALL.VMS`
  44. 4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
  45. We provide a small number of 'project files' for various IDEs to
  46. automatically build the library as well. Note that these files
  47. are not actively supported by FreeType developers, they can break
  48. or become obsolete.
  49. To find them, have a look at the content of the `builds/<system>`
  50. directory, where <system> stands for your OS or environment.
  51. 5. From you own IDE, or own Makefiles
  52. If you want to create your own project file, follow the
  53. instructions given in the `INSTALL.ANY` document of this
  54. directory.
  55. III. Custom builds of the library
  56. =================================
  57. Customizing the compilation of FreeType is easy, and allows you to
  58. select only the components of the font engine that you really need.
  59. For more details read the file `CUSTOMIZE`.
  60. ----------------------------------------------------------------------
  61. [1] make++, a make tool written in Perl, has sufficient support of GNU
  62. make extensions to build FreeType. See
  63. https://makepp.sourceforge.net
  64. for more information; you need version 2.0 or newer, and you must
  65. pass option `--norc-substitution`.
  66. ----------------------------------------------------------------------
  67. Copyright (C) 2000-2023 by
  68. David Turner, Robert Wilhelm, and Werner Lemberg.
  69. This file is part of the FreeType project, and may only be used,
  70. modified, and distributed under the terms of the FreeType project
  71. license, LICENSE.TXT. By continuing to use, modify, or distribute
  72. this file you indicate that you have read the license and understand
  73. and accept it fully.
  74. --- end of INSTALL ---