freetype/docs/INSTALL


There are several ways to  build the FreeType library, depending on your
system  and  the level  of  customization you  need.   Here  is a  short
overview of the documentation available:


I. Normal installation and upgrades
===================================

  1. Native TrueType Hinting

    Native TrueType  hinting is disabled  by default[1].  If  you really
    need it, read the file "TRUETYPE" for information.

  2. Unix Systems (as well as Cygwin or MSys on Windows)

    Please read *both* UPGRADE.UNX and INSTALL.UNX to install or upgrade
    FreeType 2  on a Unix system.   Note that you *will*  need GNU Make,
    since other make tools won't work (this includes BSD Make).

  3. On VMS with the "mms" build tool
  
    See INSTALL.VMS for installation instructions on this platform.

  4. Other systems using GNU Make
  
    On non-Unix platforms, it is possible to build the library using GNU
    Make utility.   Note that  *NO OTHER MAKE  TOOL WILL  WORK*[2]! This
    methods  supports  several compilers  on  Windows,  OS/2, and  BeOS,
    including Mingw, Visual C++, Borland C++, and more.

    Instructions are provided in the file "INSTALL.GNU".

  5. With an IDE Project File (e.g. for Visual Studio or CodeWarrior)
  
    We provide  a small  number of "project  files" for various  IDEs to
    automatically build the library as  well.  Note that these files are
    not supported and sporadically maintained by FreeType developers, so
    don't expect them to work in each release.
    
    To find  them, have a look  at the content  of the "builds/<system>"
    directory, where <system> stands for your OS or environment.

  6. From you own IDE, or own Makefiles
  
    If you want to create your own project file, follow the instructions
    given in the "INSTALL.ANY" document of this directory.


II. Custom builds of the library
================================

  Customizing the  compilation of  FreeType is easy,  and allows  you to
  select only  the components of the  font engine that  you really need.
  For more details read the file "CUSTOMIZE".


------------------------------------------------------------------------

[1] More details on:  http://www.freetype.org/patents.html

[2] make++, a  make tool written in Perl, has  sufficient support of GNU
    make       extensions       to       build      FreeType.        See
    http://makepp.sourceforge.net for more information; you need version
    1.19 or newer, and you must pass option `--norc-substitution'.

--- end of INSTALL ---
small update 2000-07-26 19:13:51 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`There are several ways to build the FreeType library, depending on your`
			`system and the level of customization you need. Here is a short`
			`overview of the documentation available:`
Removing trailing whitespace. 2000-10-31 20:42:18 +00:00
Formatting. 2002-01-09 21:01:18 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`I. Normal installation and upgrades`
			`===================================`

			`1. Native TrueType Hinting`

			`Native TrueType hinting is disabled by default[1]. If you really`
			`need it, read the file "TRUETYPE" for information.`
Formatting. 2002-01-09 21:01:18 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`2. Unix Systems (as well as Cygwin or MSys on Windows)`
Formatting. 2002-01-09 21:01:18 +00:00
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00			`Please read both UPGRADE.UNX and INSTALL.UNX to install or upgrade`
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`FreeType 2 on a Unix system. Note that you will need GNU Make,`
			`since other make tools won't work (this includes BSD Make).`
Formatting. 2002-01-09 21:01:18 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`3. On VMS with the "mms" build tool`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`See INSTALL.VMS for installation instructions on this platform.`
Formatting. 2002-01-09 21:01:18 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`4. Other systems using GNU Make`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`On non-Unix platforms, it is possible to build the library using GNU`
			`Make utility. Note that NO OTHER MAKE TOOL WILL WORK[2]! This`
			`methods supports several compilers on Windows, OS/2, and BeOS,`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00			`including Mingw, Visual C++, Borland C++, and more.`
added 'configure' and 'install' wrapper scripts to make the installation process more Unix-friendly :-) 2002-01-08 18:33:55 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`Instructions are provided in the file "INSTALL.GNU".`
* INSTALL: Added info about makepp. 2000-12-14 22:57:17 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`5. With an IDE Project File (e.g. for Visual Studio or CodeWarrior)`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`We provide a small number of "project files" for various IDEs to`
			`automatically build the library as well. Note that these files are`
			`not supported and sporadically maintained by FreeType developers, so`
			`don't expect them to work in each release.`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`To find them, have a look at the content of the "builds/<system>"`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00			`directory, where <system> stands for your OS or environment.`
* include/freetype/internal/ftstream.h: fixed the definitions of GET_LongLE and GET_ULongLE which where incorrect (creating problems in the pcf driver).. * INSTALL: updated the instructions to build shared libraries with Jam.. they were simply erroneous.. 2001-12-11 13:14:41 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`6. From you own IDE, or own Makefiles`
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00
			`If you want to create your own project file, follow the instructions`
			`given in the "INSTALL.ANY" document of this directory.`
* include/freetype/internal/ftstream.h: fixed the definitions of GET_LongLE and GET_ULongLE which where incorrect (creating problems in the pcf driver).. * INSTALL: updated the instructions to build shared libraries with Jam.. they were simply erroneous.. 2001-12-11 13:14:41 +00:00

* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`II. Custom builds of the library`
			`================================`
* include/freetype/internal/ftstream.h: fixed the definitions of GET_LongLE and GET_ULongLE which where incorrect (creating problems in the pcf driver).. * INSTALL: updated the instructions to build shared libraries with Jam.. they were simply erroneous.. 2001-12-11 13:14:41 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`Customizing the compilation of FreeType is easy, and allows you to`
			`select only the components of the font engine that you really need.`
			`For more details read the file "CUSTOMIZE".`
* include/freetype/internal/ftstream.h: fixed the definitions of GET_LongLE and GET_ULongLE which where incorrect (creating problems in the pcf driver).. * INSTALL: updated the instructions to build shared libraries with Jam.. they were simply erroneous.. 2001-12-11 13:14:41 +00:00

* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`------------------------------------------------------------------------`
* include/freetype/internal/ftstream.h: fixed the definitions of GET_LongLE and GET_ULongLE which where incorrect (creating problems in the pcf driver).. * INSTALL: updated the instructions to build shared libraries with Jam.. they were simply erroneous.. 2001-12-11 13:14:41 +00:00
* docs/: serious rewriting of the documentation include/freetype/internal/ftobjs.h, src/base/ftobjs.c, src/bdf/bdfdrivr.c, src/pcf/pcfdriver.c, src/pfr/pfrsbit.c, src/sfnt/ttsbit.c, src/type42/t42objs.c, src/winfonts/winfnt.c: introduced three new functions to deal with glyph bitmaps within FT_GlyphSlot objects. these are: ft_glyphslot_free_bitmap ft_glyphslot_alloc_bitmap ft_glyphslot_set_bitmap these are much more convenient to use than managing the FT_GLYPH_OWN_BITMAP flag manually. the font drivers have been modified to use them as well. * src/cache/ftlru.c: fixed an invalid assertion check 2003-03-20 07:04:40 +00:00			`[1] More details on: http://www.freetype.org/patents.html`
* include/freetype/internal/ftstream.h: fixed the definitions of GET_LongLE and GET_ULongLE which where incorrect (creating problems in the pcf driver).. * INSTALL: updated the instructions to build shared libraries with Jam.. they were simply erroneous.. 2001-12-11 13:14:41 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`[2] make++, a make tool written in Perl, has sufficient support of GNU`
			`make extensions to build FreeType. See`
* configure: Accept makepp also. * builds/unix/detect.mk: Use proper path to unix-def.mk. * builds/unix/unix-def.in (BUILD_DIR, PLATFORM): Remove. * builds/unix/unix.mk (BUILD_DIR, PLATFORM): Define. Use BUILD_DIR. * docs/INSTALL, docs/INSTALL.GNU, docs/INSTALL.UNX: Update documentation on makepp. 2004-04-13 08:35:05 +00:00			`http://makepp.sourceforge.net for more information; you need version`
			1.19 or newer, and you must pass option `--norc-substitution'.
small doc update 2001-05-29 10:52:34 +00:00
* doc/INSTALL.UNX: Cleaned up. Other minor fixes/beautifying/formatting. 2003-04-21 13:30:27 +00:00			`--- end of INSTALL ---`