[README] Expand on API/ABI guarantee

This commit is contained in:
Behdad Esfahbod 2025-04-04 12:30:13 -06:00
parent a55305038c
commit 089a9961ad

View file

@ -42,6 +42,14 @@ The API that comes with `hb.h` will not change incompatibly. Other, peripheral,
headers are more likely to go through minor modifications, but again, we do our
best to never change API in an incompatible way. We will never break the ABI.
The API and ABI are stable even across major version number jumps. In fact,
current HarfBuzz is API/ABI compatible all the way back to the 0.9.x series.
If one day we need to break the API/ABI, that would be called a new a library.
As such, we bump the major version number only when we add major new features,
the minor version when there is new API, and the micro version when there
are bug fixes.
## Development
For build information, see [BUILD.md](BUILD.md).