aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2022-06-12 14:00:33 -0400
committerDavid Robillard <d@drobilla.net>2022-06-12 19:37:33 -0400
commit153b828d02919209aa75c7631f1fdfdc008ea386 (patch)
tree8df127be53ffbc004803c6ffaeecbf27fe39bc80
parent0ed0823a25b4b3a9608af8ad5f601c0d2d72a122 (diff)
downloadserd-153b828d02919209aa75c7631f1fdfdc008ea386.tar.gz
serd-153b828d02919209aa75c7631f1fdfdc008ea386.tar.bz2
serd-153b828d02919209aa75c7631f1fdfdc008ea386.zip
Add note about versioning to README
-rw-r--r--NEWS3
-rw-r--r--README.md11
2 files changed, 13 insertions, 1 deletions
diff --git a/NEWS b/NEWS
index 34ecc18d..3a6ef92a 100644
--- a/NEWS
+++ b/NEWS
@@ -1,8 +1,9 @@
serd (0.30.13) unstable;
* Fix memory consumption when reading documents
+ * Update README and project metadata
- -- David Robillard <d@drobilla.net> Fri, 10 Jun 2022 13:00:11 +0000
+ -- David Robillard <d@drobilla.net> Sun, 12 Jun 2022 23:37:20 +0000
serd (0.30.12) stable;
diff --git a/README.md b/README.md
index c9af71e8..acfd98fd 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,17 @@ Documentation
* [API reference (paginated)](https://drobilla.gitlab.io/serd/c/html)
* [`serdi` man page](https://drobilla.gitlab.io/serd/man/serdi.html)
+Versioning
+----------
+
+Serd uses strict [semantic versioning](http://semver.org/), which reflects the
+ABI of the C library. The shared library name, include directory, and
+pkg-config file are all suffixed with the major version number to allow for
+parallel installation of several major versions (which distribution packages
+should preserve). To build against serd, use the pkg-config package `serd-0`:
+
+ pkg-config pkg-config --cflags --libs serd-0
+
-- David Robillard <d@drobilla.net>
[Turtle]: https://www.w3.org/TR/turtle/