Skip to content

Commit 701f0f3

Browse files
committed
Add info on the state of development to the readme
1 parent 2a06faf commit 701f0f3

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@
33
[SFML](https://www.sfml-dev.org) is a simple, fast, cross-platform and object-oriented multimedia API. It provides access to windowing,
44
graphics, audio and network.
55
It is originally written in C++, and this project is its official binding for .Net languages (C#, VB, ...).
6+
The network module is not provided in the SFML.Net binding as .NET provides superior networking support.
7+
8+
## State of Development
9+
10+
Development is focused on the next major version in the `master` branch. No more features are planned for the 2.x release series.
11+
12+
* The [`master`](https://github.com/SFML/SFML.Net/tree/master) branch contains work in progress for the next major version SFML.Net 3. As such it's considered unstable, but any testing and feedback is highly appreciated.
13+
* The [`2.6.0`](https://github.com/SFML/SFML.Net/tree/2.6.0) tag is the latest official SFML.Net release and will be the last minor release in the 2.x series.
14+
* The [`2.6.x`](https://github.com/SFML/SFML.Net/tree/2.6.x) contains the latest bugfix work on SFML.Net 2.6.x, matching CSFML's and SFML's `2.6.x` branches.
615

716
## Authors
817

9-
* Laurent Gomila - main developer ([email protected])
10-
* Zachariah Brown - active maintainer ([email protected])
18+
* Laurent Gomila ([email protected])
19+
* Lukas Dürrenberger ([email protected])
20+
* Marioalexsan ([email protected])
21+
* Zachariah Brown ([email protected])
1122

1223
## Download
1324

@@ -27,16 +38,15 @@ Of course, you can also find the SFML.Net API documentation in the SDK.
2738

2839
## Dependencies
2940

30-
The NuGet package of SFML.Net comes with all dependencies, including native CSFML
41+
The [SFML.Net NuGet package](https://www.nuget.org/packages/SFML.net) comes with all dependencies, including native CSFML
3142
and SFML libraries for most platforms.
3243

3344
For unsupported platforms or non-NuGet sources, you must have a copy of CSFML. CSFML can be compiled [from
3445
source](https://github.com/SFML/CSFML/) or downloaded from [the official release
3546
page](https://www.sfml-dev.org/download/csfml/). Also note that since CSFML depends on
3647
the main SFML project you also need all SFML runtime dependencies.
3748

38-
Another dependency is the OpenTK library. This is required by the examples to run correctly.
39-
It is not required unless you plan on running the example programs that are included.
49+
Some of the example projects also require the OpenTK library to run correctly, but it is not required for SFML.Net itself.
4050

4151
## Contribute
4252

0 commit comments

Comments
 (0)