diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..52a0aee4c0adf7e96b18afec1acb431366719c5f --- /dev/null +++ b/README.md @@ -0,0 +1,145 @@ + +# FreeType ![Badge Version] + +*A freely available software library to render fonts.* + +--- + + **[❮ Website ❯][Website]** + **[❮ Install ❯][Install]** + **[❮ Changes ❯][Changes]** + **[❮ Documentation ❯][Documentation]** + **[❮ API ❯][API]** + **[❮ License ❯][License]** + +--- + +**FreeType** is a **C** library written to produce high
+quality output in the form of glyph images of
+most vector / bitmap font formats while being: + +- **Customizable** +- **Efficient** +- **Portable** +- **Small** + +--- + +
+ +## Documentation + +Check out the [`README.git`][README.Git] for more
+info on how to work with this repository. + +### Downloads + +Additional information can be downloaded from the **[Releases]** page. +- [`freetype-doc-2.11.1.tar.xz`][Documentation XZ] +- [`freetype-doc-2.11.1.tar.gz`][Documentation GZ] +- [`ftdoc2111.zip`][Documentation ZIP] + +
+ +--- + +
+ +## Mailing Lists + +*Our preferred ways of communication are email lists.*
+*↳* [*How do I subscribe?*][Contact] + +
+ +#### General / Discussions + +[`FreeType@nongnu.org`](mailto:freetype@nongnu.org) + +#### Engine Internals / Porting + +[`FreeType-Devel@nongnu.org`](mailto:freetype-devel@nongnu.org) + +#### Announcements + +[`FreeType-Announce@nongnu.org`](mailto:freetype-announce@nongnu.org) + +#### Git Repository Tracker + +[`FreeType-Commit@nongnu.org`](mailto:freetype-commit@nongnu.org) + +
+ +***These lists are moderated.*** + +
+ +--- + +
+ +## Bugs + +You can either **[Create An Issue][Issues]** or send
+an email to [`FreeType-Devel@nongnu.org`](mailto:freetype-devel@nongnu.org) + +***Please don't forget to send a detailed explanation,***
+*there is nothing worse than receiving a terse message*
+*that only says `it doesn't work` .* + +
+ +--- + +
+ +## Patches + +Please provide a **[Merge Request]** for larger changes.
+*↳* [*How does the process work?*][Patches] + +*Alternatively, you can send patches to the*
+*[`FreeType-Devel@nongnu.org`](mailto:freetype-devel@nongnu.org) mailing list.* + +***Thank you in advance for your work on improving FreeType!*** + +**Enjoy!**
+ *\- The FreeType Team* + +
+ +--- + +
+ + Copyright (C) 2006 - 2022 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. By continuing to use, modify, or distribute + this file you indicate that you have read the license and understand + and accept it fully. + + + +[Website]: https://www.freetype.org +[Issues]: https://gitlab.freedesktop.org/freetype/freetype/-/issues +[Contact]: https://www.freetype.org/contact.html +[Merge Request]: https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests +[Patches]: https://www.freetype.org/developer.html#patches +[Documentation]: https://www.freetype.org/freetype2/docs/ +[Releases]: https://download.savannah.gnu.org/releases/freetype/ +[API]: https://freetype.org/freetype2/docs/reference/index.html + +[README.Git]: ./README.git + +[Documentation XZ]: https://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.xz +[Documentation GZ]: https://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.gz +[Documentation ZIP]: https://download.savannah.gnu.org/releases/freetype/ftdmo2111.zip + +[Install]: ./docs/INSTALL +[Changes]: ./docs/CHANGES +[License]: ./LICENSE.TXT + +[Badge Version]: https://img.shields.io/badge/version-2.11.1-blue