| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 1 | README.git |
| 2 | ---------- |
| 3 | |
| Werner Lemberg | 0fbdf11 | 2009-07-15 07:50:06 +0200 | [diff] [blame] | 4 | The git archive doesn't contain pre-built configuration scripts for |
| Werner Lemberg | b4119a9 | 2005-05-24 13:46:17 +0000 | [diff] [blame] | 5 | UNIXish platforms. To generate them say |
| 6 | |
| 7 | sh autogen.sh |
| 8 | |
| 9 | which in turn depends on the following packages: |
| Werner Lemberg | b0db0fc | 2005-03-05 17:05:35 +0000 | [diff] [blame] | 10 | |
| Werner Lemberg | a984fda | 2008-06-09 21:02:13 +0000 | [diff] [blame] | 11 | automake (1.10.1) |
| 12 | libtool (2.2.4) |
| 13 | autoconf (2.62) |
| Werner Lemberg | b0db0fc | 2005-03-05 17:05:35 +0000 | [diff] [blame] | 14 | |
| Werner Lemberg | 4ea0a7f | 2007-01-05 09:03:31 +0000 | [diff] [blame] | 15 | The versions given in parentheses are known to work. Newer versions |
| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 16 | should work too, of course. Note that `autogen.sh` also sets up |
| 17 | proper file permissions for the `configure` and auxiliary scripts. |
| Werner Lemberg | b0db0fc | 2005-03-05 17:05:35 +0000 | [diff] [blame] | 18 | |
| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 19 | The `autogen.sh` script now checks the versions of the above three |
| 20 | packages whether they match the numbers above. Otherwise it will |
| 21 | complain and suggest either upgrading or using an environment variable |
| 22 | to point to a more recent version of the required tool(s). |
| David Turner | 9750fcb | 2007-01-04 23:14:48 +0000 | [diff] [blame] | 23 | |
| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 24 | Note that `aclocal` is provided by the 'automake' package on Linux, |
| 25 | and that `libtoolize` is called `glibtoolize` on Darwin (OS X). |
| David Turner | 9750fcb | 2007-01-04 23:14:48 +0000 | [diff] [blame] | 26 | |
| 27 | |
| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 28 | For static builds that don't use platform-specific optimizations, no |
| Werner Lemberg | b0db0fc | 2005-03-05 17:05:35 +0000 | [diff] [blame] | 29 | configure script is necessary at all; saying |
| 30 | |
| 31 | make setup ansi |
| 32 | make |
| 33 | |
| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 34 | should work on all platforms that have GNU `make` (or `makepp`). |
| 35 | Similarly, a build with `cmake` or `meson` can be done directly from |
| 36 | the git repository. |
| Werner Lemberg | 60a04df | 2005-06-04 23:04:30 +0000 | [diff] [blame] | 37 | |
| 38 | |
| Werner Lemberg | 8918419 | 2021-01-16 07:53:09 +0100 | [diff] [blame] | 39 | For using the `FT_DEBUG_LOGGING` macro while debugging (see file |
| 40 | `docs/DEBUG` for more information) the following git commands are |
| 41 | necessary to check out the 'dlg' library as a git submodule. |
| Priyesh Kumar | ab0ea06 | 2020-08-28 11:28:17 +0530 | [diff] [blame] | 42 | |
| 43 | git submodule init |
| 44 | git submodule update |
| 45 | |
| 46 | |
| Werner Lemberg | b0f8675 | 2021-01-16 08:57:33 +0100 | [diff] [blame] | 47 | If you want to contribute to FreeType it is recommended to install the |
| 48 | `git-merge-changelog` program – we use a `ChangeLog` file, which often |
| 49 | prevents simple merging due to conflicts. Most GNU/Linux |
| 50 | distributions have a package for this program; otherwise you can |
| 51 | install it via the 'gnulib' git repository. Detailed instructions can |
| 52 | be found at the beginning of |
| 53 | |
| 54 | https://git.savannah.gnu.org/cgit/gnulib.git/tree/lib/git-merge-changelog.c |
| 55 | |
| 56 | To make it actually work, add to file `.git/config` in the FreeType |
| 57 | git repository (or to your `$HOME/.gitconfig` file) the lines |
| 58 | |
| 59 | [merge "merge-changelog"] |
| 60 | name = GNU-style ChangeLog merge driver |
| 61 | driver = /usr/local/bin/git-merge-changelog %O %A %B |
| 62 | |
| 63 | |
| Werner Lemberg | 4ea0a7f | 2007-01-05 09:03:31 +0000 | [diff] [blame] | 64 | ---------------------------------------------------------------------- |
| 65 | |
| Werner Lemberg | b6e8a71 | 2021-01-17 07:18:48 +0100 | [diff] [blame^] | 66 | Copyright (C) 2005-2021 by |
| Werner Lemberg | 4ea0a7f | 2007-01-05 09:03:31 +0000 | [diff] [blame] | 67 | David Turner, Robert Wilhelm, and Werner Lemberg. |
| 68 | |
| 69 | This file is part of the FreeType project, and may only be used, |
| 70 | modified, and distributed under the terms of the FreeType project |
| 71 | license, LICENSE.TXT. By continuing to use, modify, or distribute |
| 72 | this file you indicate that you have read the license and understand |
| 73 | and accept it fully. |
| 74 | |
| 75 | |
| Werner Lemberg | 8c4b462 | 2010-07-12 21:25:01 +0200 | [diff] [blame] | 76 | --- end of README.git --- |