Commit 9750fcb0676aae610857a1e40809ad3442addad2

David Turner 2007-01-04T23:14:48

* docs/INSTALL.UNIX: simplified some parts, add reference to autogen.sh and pointer to README.CVS * README.CVS: add common problem description and solution when running autogen.sh * docs/INSTALL: add reference to MacOS X * docs/MAKEPP, docs/INSTALL.MAC: add new documentation files * docs/TODO: remove obsolete items

diff --git a/README.CVS b/README.CVS
index bde3a15..0359b96 100644
--- a/README.CVS
+++ b/README.CVS
@@ -13,6 +13,19 @@ The  versions given  in  parentheses  are known  to  work.  Note  that
 autogen.sh also sets up proper  file permissions for the configure and
 auxiliary scripts.
 
+Note that a very common problem is that the script complains that
+the aclocal program doesn't accept a --force option:
+
+  generating `configure.ac'
+  running `aclocal -I . --force'
+  aclocal: unrecognized option -- `--force'
+  Try `aclocal --help' for more information.
+  error while running `aclocal -I . --force'
+
+What this really means that your version of Automake is too old,
+please update it before trying to build FreeType.
+
+
 For static builds which  don't use platform specific optimizations, no
 configure script is necessary at all; saying
 
diff --git a/docs/INSTALL b/docs/INSTALL
index 11e2fc7..572adc8 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -13,7 +13,7 @@ I. Normal installation and upgrades
     need it, read the file `TRUETYPE' for information.
 
 
-  2. Unix Systems (as well as Cygwin or MSys on Windows)
+  2. Unix Systems (including Mac OS X, as well as Cygwin or MSys on Windows)
 
     Please read *both* `UPGRADE.UNIX' and `INSTALL.UNIX' to install or
     upgrade FreeType  2 on  a Unix system.   Note that you  *need* GNU
diff --git a/docs/INSTALL.MAC b/docs/INSTALL.MAC
new file mode 100644
index 0000000..d466fc3
--- /dev/null
+++ b/docs/INSTALL.MAC
@@ -0,0 +1 @@
+Follow the instructions in INSTALL.UNIX to install FreeType on Mac OS X
diff --git a/docs/INSTALL.UNIX b/docs/INSTALL.UNIX
index aa7d67c..6a5aa31 100644
--- a/docs/INSTALL.UNIX
+++ b/docs/INSTALL.UNIX
@@ -10,26 +10,43 @@ or MSys on Win32:
     will  not be  able to  compile the  library with  the instructions
     below using any other alternative (including BSD Make).
 
-    [Well,  this  is not  really  correct.  A  few  years  ago a  perl
-    implementation of make called `makepp' has appeared which can also
-    build FreeType 2 successfully on Unix platforms.  See
+    Check that you have GNU make by running the command:
 
-      http://makepp.sourceforge.net
+       make -v
 
-    for more  details; you  need version 1.19  or newer, and  you must
-    pass option `--norc-substitution'.]
+    This should dump some text that begins with:
 
-    Trying  to compile  the library  with a  different Make  tool will
-    print a message like:
+       GNU Make  <version number>
+       Copyright (C) <year> Free Software Foundation Inc.
 
-      Sorry, GNU make is required to build FreeType2.
+    Note that version 3.78.1 or higher is *required*, or the build will
+    fail.
 
-    and the build  process will be aborted.  If  this happens, install
-    GNU Make on your system,  and use the GNUMAKE environment variable
-    to name it, if necessary.
+    It's also OK to have GNU Make under another name (e.g. 'gmake')
+    if you use the GNUMAKE trick described below.
 
+    As a special exception, 'makepp' can also be used to build
+    FreeType 2. See the file docs/MAKEPP for details
 
-  2. Build and install the library
+
+  2. Regenerate the configure script when needed
+  ----------------------------------------------
+
+   This only applies if you're building a CVS snapshot or checkout,
+   *not* if you grabbed the sources of an official release.
+
+   you need to invoke the "autogen.sh" script in the top-level
+   directory in order to re-generate the configure script for your
+   platform. Normally, this simply means typing:
+
+     sh autogen.sh <your configure options>
+
+   in case of problems, you may need to install or upgrade Automake,
+   Autoconf or Libtool. See README.CVS in the top-level directory for
+   the gory details.
+    
+
+  3. Build and install the library
   --------------------------------
 
     The following  should work  on all Unix  systems where  the `make'
diff --git a/docs/MAKEPP b/docs/MAKEPP
new file mode 100644
index 0000000..97512cc
--- /dev/null
+++ b/docs/MAKEPP
@@ -0,0 +1,5 @@
+As a special exception, FreeType can also be built with the
+'makepp' build tool, available from http://makepp.sourceforge.net
+
+Note however that you will need at least version 1.19 and pass
+the option --norc-substitution to have it work correctly
diff --git a/docs/TODO b/docs/TODO
index 7a32259..4d38fcf 100644
--- a/docs/TODO
+++ b/docs/TODO
@@ -3,12 +3,6 @@ Here is a list of items that need to be addressed in FreeType 2
 
 * Implement stem3/counter hints properly in the Postscript hinter.
 
-* Finalize the cache sub-system.  It has been in beta far too long :-)
-
-* The automatic and Postscript hinters have been improved to increase
-  the quality of AA text, but Monochrome and LCD hinting still suck.  We
-  need to do something about that.
-
 * Add CIDCMap support to the CID driver.
 
 * Add track kerning support to the PFR driver.