summaryrefslogtreecommitdiffstats
path: root/modules/freetype2/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--modules/freetype2/README107
-rw-r--r--modules/freetype2/README.git102
-rw-r--r--modules/freetype2/README.moz-patches5
3 files changed, 214 insertions, 0 deletions
diff --git a/modules/freetype2/README b/modules/freetype2/README
new file mode 100644
index 0000000000..327b94d8e5
--- /dev/null
+++ b/modules/freetype2/README
@@ -0,0 +1,107 @@
+FreeType 2.13.0
+===============
+
+Homepage: https://www.freetype.org
+
+FreeType is a freely available software library to render fonts.
+
+It is written in C, designed to be small, efficient, highly
+customizable, and portable while capable of producing high-quality
+output (glyph images) of most vector and bitmap font formats.
+
+Please read the `docs/CHANGES` file, it contains IMPORTANT
+INFORMATION.
+
+Read the files `docs/INSTALL*` for installation instructions; see the
+file `docs/LICENSE.TXT` for the available licenses.
+
+For using FreeType's git repository instead of a distribution bundle,
+please read file `README.git`. Note that you have to actually clone
+the repository; using a snapshot will not work (in other words, don't
+use gitlab's 'Download' button).
+
+The FreeType 2 API reference is located in directory `docs/reference`;
+use the file `index.html` as the top entry point. [Please note that
+currently the search function for locally installed documentation
+doesn't work due to cross-site scripting issues.]
+
+Additional documentation is available as a separate package from our
+sites. Go to
+
+ https://download.savannah.gnu.org/releases/freetype/
+
+and download one of the following files.
+
+ freetype-doc-2.13.0.tar.xz
+ freetype-doc-2.13.0.tar.gz
+ ftdoc2130.zip
+
+To view the documentation online, go to
+
+ https://www.freetype.org/freetype2/docs/
+
+
+Mailing Lists
+-------------
+
+The preferred way of communication with the FreeType team is using
+e-mail lists.
+
+ general use and discussion: freetype@nongnu.org
+ engine internals, porting, etc.: freetype-devel@nongnu.org
+ announcements: freetype-announce@nongnu.org
+ git repository tracker: freetype-commit@nongnu.org
+
+The lists are moderated; see
+
+ https://www.freetype.org/contact.html
+
+how to subscribe.
+
+
+Bugs
+----
+
+Please submit bug reports at
+
+ https://gitlab.freedesktop.org/freetype/freetype/-/issues
+
+Alternatively, you might report bugs by e-mail to
+`freetype-devel@nongnu.org`. Don't forget to send a detailed
+explanation of the problem -- there is nothing worse than receiving a
+terse message that only says 'it doesn't work'.
+
+
+Patches
+-------
+
+For larger changes please provide merge requests at
+
+ https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests
+
+Alternatively, you can send patches to the `freetype-devel@nongnu.org`
+mailing list -- and thank you in advance for your work on improving
+FreeType!
+
+Details on the process can be found here:
+
+ https://www.freetype.org/developer.html#patches
+
+
+Enjoy!
+
+ The FreeType Team
+
+----------------------------------------------------------------------
+
+Copyright (C) 2006-2023 by
+David Turner, Robert Wilhelm, and Werner Lemberg.
+
+This file is part of the FreeType project, and may only be used,
+modified, and distributed under the terms of the FreeType project
+license, LICENSE.TXT. By continuing to use, modify, or distribute
+this file you indicate that you have read the license and understand
+and accept it fully.
+
+
+--- end of README ---
diff --git a/modules/freetype2/README.git b/modules/freetype2/README.git
new file mode 100644
index 0000000000..117d74f0d9
--- /dev/null
+++ b/modules/freetype2/README.git
@@ -0,0 +1,102 @@
+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
+
+which in turn depends on the following packages:
+
+ automake (1.10.1)
+ libtool (2.2.4)
+ 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.
+
+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`).
+
+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.
+
+
+Code of Conduct
+---------------
+
+Please note that this project is released with a Contributor Code of
+Conduct (CoC). By participating in this project you agree to abide by
+its terms, which you can find in the following link:
+
+ https://www.freedesktop.org/wiki/CodeOfConduct
+
+CoC issues may be raised to the project maintainers at the following
+address:
+
+ wl@gnu.org
+ apodtele@gmail.com
+
+----------------------------------------------------------------------
+
+Copyright (C) 2005-2023 by
+David Turner, Robert Wilhelm, and Werner Lemberg.
+
+This file is part of the FreeType project, and may only be used,
+modified, and distributed under the terms of the FreeType project
+license, LICENSE.TXT. By continuing to use, modify, or distribute
+this file you indicate that you have read the license and understand
+and accept it fully.
+
+
+--- end of README.git ---
diff --git a/modules/freetype2/README.moz-patches b/modules/freetype2/README.moz-patches
new file mode 100644
index 0000000000..d7308d36eb
--- /dev/null
+++ b/modules/freetype2/README.moz-patches
@@ -0,0 +1,5 @@
+This directory contains FreeType v2.13.0 downloaded from
+https://download.savannah.gnu.org/releases/freetype/
+
+No post-2.13.0 commits have been cherry-picked from the upstream FreeType
+repository at this time.