ref: 5e32a03496327d6e73fc108a315d76511dd41a50
parent: a399fb89dcee90629dcaaa9570fa2f5ab748100c
author: Werner Lemberg <[email protected]>
date: Sat Jul 3 16:24:16 EDT 2021
README.git: Revised.
--- a/README.git
+++ b/README.git
@@ -1,6 +1,10 @@
README.git
-----------
+==========
+
+repository issues
+-----------------
+
FreeType's official repository site is
https://gitlab.freedesktop.org/freetype ,
@@ -23,7 +27,10 @@
freetype-demos
-The git archive doesn't contain pre-built configuration scripts for
+standard builds with `configure`
+--------------------------------
+
+The git repository doesn't contain pre-built configuration scripts for
UNIXish platforms. To generate them say
sh autogen.sh
@@ -38,15 +45,18 @@
should work too, of course. Note that `autogen.sh` also sets up
proper file permissions for the `configure` and auxiliary scripts.
-The `autogen.sh` script now checks the versions of the above three
-packages whether they match the numbers above. Otherwise it will
-complain and suggest either upgrading or using an environment variable
-to point to a more recent version of the required tool(s).
+The `autogen.sh` script checks whether the versions of the above three
+tools match the numbers above. Otherwise it will complain and suggest
+either upgrading or using environment variables to point to more
+recent versions of the required tools.
Note that `aclocal` is provided by the 'automake' package on Linux,
and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
+alternative build methods
+-------------------------
+
For static builds that don't use platform-specific optimizations, no
configure script is necessary at all; saying
@@ -53,18 +63,17 @@
make setup ansi
make
-should work on all platforms that have GNU `make` (or `makepp`).
-Similarly, a build with `cmake` or `meson` can be done directly from
-the git repository.
+should work on all platforms that have GNU `make` (or `makepp`).
+A build with `cmake` or `meson` can be done directly from the git
+repository. However, if you want to use the `FT_DEBUG_LOGGING` macro
+(see file `docs/DEBUG` for more information) it is currently mandatory
+to execute `autogen.sh` in advance; this script clones the 'dlg' git
+submodule and copies some files into FreeType's source tree.
-For using the `FT_DEBUG_LOGGING` macro while debugging (see file
-`docs/DEBUG` for more information) the following git commands are
-necessary to check out the 'dlg' library as a git submodule.
- git submodule init
- git submodule update
-
+contributing
+------------
If you want to contribute to FreeType it is recommended to install the
`git-merge-changelog` program – we use a `ChangeLog` file, which often