readme: document versioning and stability expectations

References: https://gitlab.freedesktop.org/emersion/libdisplay-info/-/issues/13
Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2023-01-17 11:48:41 +01:00
parent 6cdebd2046
commit 0154eaa29c

View file

@ -24,6 +24,8 @@ If the additions are rejected, you are welcome to use the low-level API.
This policy is aimed to propagate best practises when interpreting EDID
and DisplayID information which can often be cryptic or even inconsistent.
libdisplay-info uses [semantic versioning]. The public API is not yet stable.
## Contributing
Open issues and merge requests on the [GitLab project].
@ -67,6 +69,7 @@ To fuzz libdisplay-info with [AFL], the library needs to be instrumented:
afl-fuzz -i test/data/ -o afl/ build/di-edid-decode/di-edid-decode
[website]: https://emersion.pages.freedesktop.org/libdisplay-info/
[semantic versioning]: https://semver.org/
[GitLab project]: https://gitlab.freedesktop.org/emersion/libdisplay-info
[Wayland contribution guidelines]: https://gitlab.freedesktop.org/wayland/wayland/-/blob/main/CONTRIBUTING.md
[Developer Certificate of Origin 1.1]: https://developercertificate.org/