Merge branch 'master' into 'master'

README Rework

See merge request freetype/freetype!150
This commit is contained in:
トトも 2025-10-02 20:07:46 +00:00
commit 6a49900d40

145
README.md Normal file
View file

@ -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 <br>
quality output in the form of glyph images of <br>
most vector / bitmap font formats while being:
- **Customizable**
- **Efficient**
- **Portable**
- **Small**
---
<br>
## Documentation
Check out the [`README.git`][README.Git] for more <br>
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]
<br>
---
<br>
## Mailing Lists
*Our preferred ways of communication are email lists.* <br>
*↳* [*How do I subscribe?*][Contact]
<br>
#### 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)
<br>
***These lists are moderated.***
<br>
---
<br>
## Bugs
You can either **[Create An Issue][Issues]** or send <br>
an email to [`FreeType-Devel@nongnu.org`](mailto:freetype-devel@nongnu.org)
***Please don't forget to send a detailed explanation,*** <br>
*there is nothing worse than receiving a terse message* <br>
*that only says `it doesn't work` .*
<br>
---
<br>
## Patches
Please provide a **[Merge Request]** for larger changes. <br>
*↳* [*How does the process work?*][Patches]
*Alternatively, you can send patches to the* <br>
*[`FreeType-Devel@nongnu.org`](mailto:freetype-devel@nongnu.org) mailing list.*
***Thank you in advance for your work on improving FreeType!***
**Enjoy!** <br>
*\- The FreeType Team*
<br>
---
<br>
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