Add README.md

This commit is contained in:
2026-09-12 06:45:24 +00:00
parent bf6c4411df
commit 38daf046ba

9
README.md Normal file
View File

@@ -0,0 +1,9 @@
# allegro_schrift
Drop-in replacement for Allegro_TTF that contains libschrift, instead of using FreeType2.
It is 100% API compatible with the vanilla TrueType addon. Compile Allegro with these files inside of `/addons/ttf`.
Caveats:
- Stretching is not implemented. Maybe later.
- The entire caching system is gone, fonts are baked to textures immediately and no further. If your usecase doesn't need every fancy rendering feature and can use schrift, you probably aren't supporting enough characters and languages to need on-the-fly caching.
- The `cache_text` setting in allegro5.cfg is now reused to determine what glyphs can be rendered at all. `skip_cache_misses` has no effect.