summaryrefslogtreecommitdiff
path: root/Build/source/libs/freetype2/freetype-src/README.git
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/libs/freetype2/freetype-src/README.git')
-rw-r--r--Build/source/libs/freetype2/freetype-src/README.git85
1 files changed, 71 insertions, 14 deletions
diff --git a/Build/source/libs/freetype2/freetype-src/README.git b/Build/source/libs/freetype2/freetype-src/README.git
index c4f0033c1a5..2bed537d224 100644
--- a/Build/source/libs/freetype2/freetype-src/README.git
+++ b/Build/source/libs/freetype2/freetype-src/README.git
@@ -1,4 +1,36 @@
-The git archive doesn't contain pre-built configuration scripts for
+README.git
+==========
+
+
+repository issues
+-----------------
+
+FreeType's official repository site is
+
+ https://gitlab.freedesktop.org/freetype ,
+
+from which the 'freetype.git' and 'freetype-demos.git' repositories
+can be cloned in the usual way.
+
+ git clone https://gitlab.freedesktop.org/freetype/freetype.git
+ git clone https://gitlab.freedesktop.org/freetype/freetype-demos.git
+
+If you want to use the Savannah mirror instead, you have to do a
+slightly different incantation because the repository names contain
+digit '2' for historical reasons.
+
+ git clone \
+ https://git.savannah.nongnu.org/git/freetype/freetype2.git \
+ freetype
+ git clone \
+ https://git.savannah.nongnu.org/git/freetype/freetype2-demos.git \
+ freetype-demos
+
+
+standard builds with `configure`
+--------------------------------
+
+The git repository doesn't contain pre-built configuration scripts for
UNIXish platforms. To generate them say
sh autogen.sh
@@ -10,34 +42,59 @@ which in turn depends on the following packages:
autoconf (2.62)
The versions given in parentheses are known to work. Newer versions
-should work too, of course. Note that autogen.sh also sets up proper
-file permissions for the `configure' and auxiliary scripts.
+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 version of 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).
+Note that `aclocal` is provided by the 'automake' package on Linux,
+and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
-For static builds which don't use platform specific optimizations, no
+alternative build methods
+-------------------------
+
+For static builds that don't use platform-specific optimizations, no
configure script is necessary at all; saying
make setup ansi
make
-should work on all platforms which have GNU make (or makepp).
+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.
+
+
+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
+prevents simple merging due to conflicts. Most GNU/Linux
+distributions have a package for this program; otherwise you can
+install it via the 'gnulib' git repository. Detailed instructions can
+be found at the beginning of
+
+ https://git.savannah.gnu.org/cgit/gnulib.git/tree/lib/git-merge-changelog.c
+To make it actually work, add to file `.git/config` in the FreeType
+git repository (or to your `$HOME/.gitconfig` file) the lines
-Similarly, a build with `cmake' can be done directly from the git
-repository.
+ [merge "merge-changelog"]
+ name = GNU-style ChangeLog merge driver
+ driver = /usr/local/bin/git-merge-changelog %O %A %B
----------------------------------------------------------------------
-Copyright (C) 2005-2020 by
+Copyright (C) 2005-2021 by
David Turner, Robert Wilhelm, and Werner Lemberg.
This file is part of the FreeType project, and may only be used,