home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: SysTools / SysTools.zip / ft-beta.zip / freetype / docs / readme.txt < prev    next >
Text File  |  1997-10-06  |  4KB  |  105 lines

  1. Welcome to the documentation directory.
  2.  
  3. Most of the  files here are obsolete or  will undergo great changes!
  4. However, the following titles are up-to-date and useful:
  5.  
  6.  
  7.   ..................................................................
  8.  
  9.   apiref.txt    FreeType high-level  API reference.  All  the types,
  10.                 functions and error codes of FreeType
  11.  
  12.   ..................................................................
  13.  
  14.   user.txt      FreeType's  user  guide.    A  guide  to  FreeType's
  15.                 concepts, a  step by step example, and  a note about
  16.                 future works and projects.
  17.  
  18.  
  19.  
  20. The following files are incomplete, but useful:
  21.  
  22.   ..................................................................
  23.  
  24.   FAQ           A  rather obsolete  faq,  but many  of its  sections
  25.                 remain true.
  26.  
  27.   ..................................................................
  28.  
  29.   convntns.txt  The  FreeType developer's conventions  guide.  Lists
  30.                 the  design  and  coding  conventions  used  in  the
  31.                 engine's source  code.  This file  is incomplete and
  32.                 needs   some  updates,   but  still   contains  very
  33.                 important information.
  34.  
  35.   ..................................................................
  36.  
  37.   history.txt   FreeType's history.  Yes,  this engine is the result
  38.                 of several  damaged brains who decided  to provide a
  39.                 _real_  TrueType engine  to the  masses.   This text
  40.                 isn't  up to  date  but gives  some relatively  good
  41.                 info.
  42.  
  43.   ..................................................................
  44.  
  45.   memory.txt    This document is  a draft that originated FreeType's
  46.                 internal memory and object management model. Even if
  47.                 the real one is  more sophisticated, this file gives
  48.                 some interesting clues. It will soon disappear.
  49.  
  50.   ..................................................................
  51.  
  52.   raster.doc    The  scan-line converter's internals  explained. The
  53.                 document is  still incomplete but  presents many key
  54.                 concepts.
  55.  
  56.  
  57. Soon to come:   These  documents will probably  come with  the first
  58.                 public release, also known as FreeType 1.0.
  59.  
  60.   FAQ           An updated  FreeType faq, with  many more questions,
  61.                 and answers!
  62.  
  63.   ..................................................................
  64.  
  65.   develop.txt   The FreeType developer's guide. All you need to know
  66.                 in order to be able  to understand and even hack the
  67.                 engine's core source code.
  68.  
  69.   ..................................................................
  70.  
  71.   extend.txt    The FreeType extension writer's how-to. All you need
  72.                 to be able to provide new extensions to the engine.
  73.  
  74.   ..................................................................
  75.  
  76.   porting.txt   The  FreeType  porting   guide.   All  you  need  to
  77.                 configure  and adapt  very  easily FreeType's source
  78.                 code to tailor it to your own platform.
  79.  
  80.                 Learn how to provide  your own memory, i/o and mutex
  81.                 components, best fitted to your system.  See how you
  82.                 can   build   a   singly-threaded,  thread-safe   or
  83.                 re-entrant  version  of  the  engine from  the  same
  84.                 source code!
  85.  
  86.   ..................................................................
  87.  
  88.   history.txt   Updated, with all the  juicy bits!  Things you could
  89.                 have never imagined from FreeType's authors (neither
  90.                 did we :-)
  91.  
  92.   ..................................................................
  93.  
  94.   undoc.txt     Undocumented TrueType!
  95.  
  96.                 Yes,    ladies   and    gentlemen,    the   TrueType
  97.                 specification  is  fuzzy  and misleading  enough  to
  98.                 disband  some  serious  commercial  developers,  but
  99.                 that's wasn't  enough for  us.  Even though  it took
  100.                 some time (aaargh...), we finally discovered through
  101.                 hard work the real meanings of the specs, fixed some
  102.                 errors   and  even  found   surprising  undocumented
  103.                 behaviour or features!
  104.  
  105.