README.git 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. README.git
  2. ==========
  3. repository issues
  4. -----------------
  5. FreeType's official repository site is
  6. https://gitlab.freedesktop.org/freetype ,
  7. from which the 'freetype.git' and 'freetype-demos.git' repositories
  8. can be cloned in the usual way.
  9. git clone https://gitlab.freedesktop.org/freetype/freetype.git
  10. git clone https://gitlab.freedesktop.org/freetype/freetype-demos.git
  11. If you want to use the Savannah mirror instead, you have to do a
  12. slightly different incantation because the repository names contain
  13. digit '2' for historical reasons.
  14. git clone \
  15. https://git.savannah.nongnu.org/git/freetype/freetype2.git \
  16. freetype
  17. git clone \
  18. https://git.savannah.nongnu.org/git/freetype/freetype2-demos.git \
  19. freetype-demos
  20. standard builds with `configure`
  21. --------------------------------
  22. The git repository doesn't contain pre-built configuration scripts for
  23. UNIXish platforms. To generate them say
  24. sh autogen.sh
  25. which in turn depends on the following packages:
  26. automake (1.10.1)
  27. libtool (2.2.4)
  28. autoconf (2.62)
  29. The versions given in parentheses are known to work. Newer versions
  30. should work too, of course. Note that `autogen.sh` also sets up
  31. proper file permissions for the `configure` and auxiliary scripts.
  32. The `autogen.sh` script checks whether the versions of the above three
  33. tools match the numbers above. Otherwise it will complain and suggest
  34. either upgrading or using environment variables to point to more
  35. recent versions of the required tools.
  36. Note that `aclocal` is provided by the 'automake' package on Linux,
  37. and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
  38. alternative build methods
  39. -------------------------
  40. For static builds that don't use platform-specific optimizations, no
  41. configure script is necessary at all; saying
  42. make setup ansi
  43. make
  44. should work on all platforms that have GNU `make` (or `makepp`).
  45. A build with `cmake` or `meson` can be done directly from the git
  46. repository. However, if you want to use the `FT_DEBUG_LOGGING` macro
  47. (see file `docs/DEBUG` for more information) it is currently mandatory
  48. to execute `autogen.sh` in advance; this script clones the 'dlg' git
  49. submodule and copies some files into FreeType's source tree.
  50. Code of Conduct
  51. ---------------
  52. Please note that this project is released with a Contributor Code of
  53. Conduct (CoC). By participating in this project you agree to abide by
  54. its terms, which you can find in the following link:
  55. https://www.freedesktop.org/wiki/CodeOfConduct
  56. CoC issues may be raised to the project maintainers at the following
  57. address:
  58. wl@gnu.org
  59. apodtele@gmail.com
  60. ----------------------------------------------------------------------
  61. Copyright (C) 2005-2023 by
  62. David Turner, Robert Wilhelm, and Werner Lemberg.
  63. This file is part of the FreeType project, and may only be used,
  64. modified, and distributed under the terms of the FreeType project
  65. license, LICENSE.TXT. By continuing to use, modify, or distribute
  66. this file you indicate that you have read the license and understand
  67. and accept it fully.
  68. --- end of README.git ---