Skip to content

Commit d2934c8

Browse files
committed
Release 2.5.5 compatible with CSFML 2.5.2
1 parent 62751b0 commit d2934c8

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,22 @@ is Audio, System, Graphics, Window and Network.
3535
parameters.
3636
* Unicode is supported using `Wide_Wide_String` in Ada where the C API uses `sfUint32*`
3737

38+
## Compatibility with CSFML releases
39+
The versioning scheme of ASFML follows the one of CSFML for the major
40+
and minor numbers; while the patch number is, in principle,
41+
independent. This means, for example, that 2.4.x releases are expected
42+
to be compatible with all 2.4.x releases of CSFML. Note, however, that
43+
some CSFML releases change the API to fix problems with the binding to
44+
SFML and they release them as a patch. Consequently, there are cases,
45+
like CSFML 2.5.2, which requires a specific patch level of ASFML, in this
46+
case, ASFML 2.5.5. When this happens, the Alire dependencies reflect
47+
the requirement.
48+
49+
Nevertheless, the usual problems that can be found when doing an
50+
heterogeneous linking are only spotted when calling one of the
51+
functions having changed between the releases. Otherwise, the
52+
incompatibility will be latent.
53+
3854
## How to build with Alire
3955

4056
This library is available in [Alire](https://alire.ada.dev/) so building is as easy as installing Alire and then executing:

alire.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "asfml"
22
description = "An Ada binding to SFML, the Simple and Fast Multimedia Library"
3-
version = "2.5.5-dev"
3+
version = "2.5.5"
44
long-description = """
55
[![ASFML logo](https://raw.githubusercontent.com/mgrojo/ASFML/master/images/ASFML_Logo.svg)](https://www.sfml-dev.org)
66
![Ada (GNAT)](https://github.com/mgrojo/ASFML/workflows/Ada%20(GNAT)/badge.svg)
@@ -31,4 +31,4 @@ website = "https://mgrojo.github.io/ASFML/"
3131
tags = ["audio", "games", "opengl", "cross-platform", "multimedia", "binding", "graphics", "sfml"]
3232

3333
[[depends-on]]
34-
libcsfml = "^2.5"
34+
libcsfml = "^2.5.2"

0 commit comments

Comments
 (0)