README.git: Revised.

This commit is contained in:
Werner Lemberg 2021-07-03 20:24:16 +02:00
parent a399fb89dc
commit 5e32a03496
1 changed files with 25 additions and 16 deletions

View File

@ -1,5 +1,9 @@
README.git README.git
---------- ==========
repository issues
-----------------
FreeType's official repository site is FreeType's official repository site is
@ -23,7 +27,10 @@ digit '2' for historical reasons.
freetype-demos 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 UNIXish platforms. To generate them say
sh autogen.sh sh autogen.sh
@ -38,33 +45,35 @@ The versions given in parentheses are known to work. Newer versions
should work too, of course. Note that `autogen.sh` also sets up should work too, of course. Note that `autogen.sh` also sets up
proper file permissions for the `configure` and auxiliary scripts. proper file permissions for the `configure` and auxiliary scripts.
The `autogen.sh` script now checks the versions of the above three The `autogen.sh` script checks whether the versions of the above three
packages whether they match the numbers above. Otherwise it will tools match the numbers above. Otherwise it will complain and suggest
complain and suggest either upgrading or using an environment variable either upgrading or using environment variables to point to more
to point to a more recent version of the required tool(s). recent versions of the required tools.
Note that `aclocal` is provided by the 'automake' package on Linux, Note that `aclocal` is provided by the 'automake' package on Linux,
and that `libtoolize` is called `glibtoolize` on Darwin (OS X). and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
alternative build methods
-------------------------
For static builds that don't use platform-specific optimizations, no For static builds that don't use platform-specific optimizations, no
configure script is necessary at all; saying configure script is necessary at all; saying
make setup ansi make setup ansi
make make
should work on all platforms that have GNU `make` (or `makepp`). 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. 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 contributing
`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
If you want to contribute to FreeType it is recommended to install the If you want to contribute to FreeType it is recommended to install the
`git-merge-changelog` program we use a `ChangeLog` file, which often `git-merge-changelog` program we use a `ChangeLog` file, which often