diff --git a/README b/README index e4c8cf1c5..e50368045 100644 --- a/README +++ b/README @@ -1,88 +1,92 @@ - FreeType 2.10.4 - =============== +FreeType 2.10.4 +=============== - Homepage: https://www.freetype.org +Homepage: https://www.freetype.org - FreeType is a freely available software library to render fonts. +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. +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. +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. +Read the files `docs/INSTALL*` for installation instructions; see the +file `docs/LICENSE.TXT` for the available licenses. - The FreeType 2 API reference is located in `docs/reference/site'; - 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.] +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 +Additional documentation is available as a separate package from our +sites. Go to - https://download.savannah.gnu.org/releases/freetype/ + https://download.savannah.gnu.org/releases/freetype/ - and download one of the following files. +and download one of the following files. - freetype-doc-2.10.4.tar.xz - freetype-doc-2.10.4.tar.gz - ftdoc2104.zip + freetype-doc-2.10.4.tar.xz + freetype-doc-2.10.4.tar.gz + ftdoc2104.zip - To view the documentation online, go to +To view the documentation online, go to - https://www.freetype.org/freetype2/docs/ + https://www.freetype.org/freetype2/docs/ - Mailing Lists - ============= +Mailing Lists +------------- - The preferred way of communication with the FreeType team is using - e-mail 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 + 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 +The lists are moderated; see - https://www.freetype.org/contact.html + https://www.freetype.org/contact.html - how to subscribe. +how to subscribe. - Bugs - ==== +Bugs +---- - Please submit bug reports at +Please submit bug reports at - https://savannah.nongnu.org/bugs/?group=freetype + 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'. +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 - ======= +Patches +------- - Please submit patches to the `freetype-devel@nongnu.org' mailing - list -- and thank you in advance for your work on improving - FreeType! +For larger changes please provide merge requests at - Details on the process can be found here: + https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests - https://www.freetype.org/developer.html#patches +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! +Enjoy! - The FreeType Team + The FreeType Team ---------------------------------------------------------------------- diff --git a/README.git b/README.git index 265643df8..fcf203025 100644 --- a/README.git +++ b/README.git @@ -1,3 +1,6 @@ +README.git +---------- + The git archive doesn't contain pre-built configuration scripts for UNIXish platforms. To generate them say @@ -10,34 +13,32 @@ 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 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). -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 +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`). +Similarly, a build with `cmake` or `meson` can be done directly from +the git repository. -Similarly, a build with `cmake' can be done directly from the git -repository. - - -For using the `FT_DEBUG_LOGGING' macro while debugging (see -`docs/DEBUG' for more information) use the following git commands to -checkout `dlg' library as a git submodule. +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. git submodule init git submodule update