summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2021-07-03 20:24:16 +0200
committerWerner Lemberg <wl@gnu.org>2021-07-03 20:24:16 +0200
commit5e32a03496327d6e73fc108a315d76511dd41a50 (patch)
tree0a4baa17cee7b17403e4b449314f632e039b8b09
parenta399fb89dcee90629dcaaa9570fa2f5ab748100c (diff)
downloadfreetype2-5e32a03496327d6e73fc108a315d76511dd41a50.tar.gz
README.git: Revised.
-rw-r--r--README.git39
1 files changed, 24 insertions, 15 deletions
diff --git a/README.git b/README.git
index b8ba9b4c3..2bed537d2 100644
--- a/README.git
+++ b/README.git
@@ -1,5 +1,9 @@
README.git
-----------
+==========
+
+
+repository issues
+-----------------
FreeType's official repository site is
@@ -23,7 +27,10 @@ digit '2' for historical reasons.
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,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
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
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`).
-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.
+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.
- 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