Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add clarification of SFML's status of development

Browse Source 
Co-authored-by: kimci86 <kimci86@hotmail.fr>
This commit is contained in:
Lukas Dürrenberger 2022-05-01 18:33:31 +02:00
parent 3ae85854e4
commit 08982064f5
1 changed files with 31 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
readme.md
View File

@ -4,23 +4,19 @@
SFML is a simple, fast, cross-platform and object-oriented multimedia API. It provides access to windowing, graphics, audio and network. It is written in C++, and has bindings for various languages such as C, .Net, Ruby, Python.
## Authors
## State of Development
- Laurent Gomila (laurent@sfml-dev.org)
- Marco Antognini (hiura@sfml-dev.org)
- binary1248 (binary1248@hotmail.com)
- Lukas Dürrenberger (eXpl0it3r@sfml-dev.org)
- Jonathan De Wachter (dewachter.jonathan@gmail.com)
- Jan Haller (bromeon@sfml-dev.org)
- Mario Liebisch (mario@sfml-dev.org)
- Stefan Schindler (tank@sfml-dev.org)
- Artur Moreira (artturmoreira@gmail.com)
- Vittorio Romeo (vittorioromeo@sfml-dev.org)
- And many other members of the SFML community
SFML is currently in an interesting state of development, which can quickly become confusing if you aren't following it closely. As such we want to clarify where to get which version.
- The [`master`](https://github.com/SFML/SFML/tree/master) branch contains work in progress for the next major version SFML 3. As such it's considered unstable, but any testing and feedback is highly appreciated.
- The [`2.6.x`](https://github.com/SFML/SFML/tree/2.6.x) branch is the nearly complete next minor version SFML 2.6, which should be very stable, even if it hasn't been officially released yet.
- The [`2.5.1`](https://github.com/SFML/SFML/tree/2.5.1) tag is the last official SFML release, but it lacks a lot of fixes and features that can already be found on the `2.6.x` branch.
## Download
You can get the latest official release on [SFML's website](https://www.sfml-dev.org/download.php). You can also get the current development version from the [Git repository](https://github.com/SFML/SFML).
- You can get the latest official release on [SFML's website](https://www.sfml-dev.org/download.php).
- You can also get the source code of the current development version from the [Git repository](https://github.com/SFML/SFML).
- Alternatively, you can get the latest snapshot / artifact builds from the [artifacts storage](https://artifacts.sfml-dev.org/by-branch/master/).
## Install
@ -37,6 +33,7 @@ There are several places to learn SFML:
## Community
Here are some useful community links:
- [Discord](https://discord.gg/nr4X7Fh)
- [Twitter](https://twitter.com/sfmldev)
- [Forum](https://en.sfml-dev.org/forums/) ([French](https://fr.sfml-dev.org/forums/))
@ -45,6 +42,20 @@ Here are some useful community links:
SFML is an open-source project, and it needs your help to go on growing and improving. If you want to get involved and suggest some additional features, file a bug report or submit a patch, please have a look at the [contribution guidelines](https://www.sfml-dev.org/contribute.php).
## Authors
- Laurent Gomila (laurent@sfml-dev.org)
- Marco Antognini (hiura@sfml-dev.org)
- binary1248 (binary1248@hotmail.com)
- Lukas Dürrenberger (eXpl0it3r@sfml-dev.org)
- Jonathan De Wachter (dewachter.jonathan@gmail.com)
- Jan Haller (bromeon@sfml-dev.org)
- Mario Liebisch (mario@sfml-dev.org)
- Stefan Schindler (tank@sfml-dev.org)
- Artur Moreira (artturmoreira@gmail.com)
- Vittorio Romeo (vittorioromeo@sfml-dev.org)
- And many other members of the SFML community
## License
The SFML libraries and source code are distributed under the [zlib/libpng license](https://opensource.org/licenses/Zlib). See [license.md](license.md). External libraries used by SFML are distributed under their own licenses.
@ -53,10 +64,10 @@ In short, SFML is free for any use (commercial or personal, proprietary or open-
## External libraries used by SFML
* [_OpenAL-Soft_](https://github.com/kcat/openal-soft) is under the [LGPL license](https://github.com/kcat/openal-soft/blob/master/COPYING)
* [_stb\_image_ and _stb_image_write_](https://github.com/nothings/stb) are [public domain](https://github.com/nothings/stb/blob/master/LICENSE)
* [_freetype_](https://gitlab.freedesktop.org/freetype/freetype) is under the [FreeType license or the GPL license](https://gitlab.freedesktop.org/freetype/freetype/-/blob/master/LICENSE.TXT)
* [_libogg_](https://gitlab.xiph.org/xiph/ogg) is under the [BSD license](https://gitlab.xiph.org/xiph/ogg/-/blob/master/COPYING)
* [_libvorbis_](https://gitlab.xiph.org/xiph/vorbis) is under the [BSD license](https://gitlab.xiph.org/xiph/vorbis/-/blob/master/COPYING)
* [_libflac_](https://gitlab.xiph.org/xiph/flac) is under the [BSD license](https://gitlab.xiph.org/xiph/flac/-/blob/master/COPYING.Xiph)
* [_minimp3_](https://github.com/lieff/minimp3) is under the [CC0 license](https://github.com/lieff/minimp3/blob/master/LICENSE)
- [_OpenAL-Soft_](https://github.com/kcat/openal-soft) is under the [LGPL license](https://github.com/kcat/openal-soft/blob/master/COPYING)
- [_stb_image_ and _stb_image_write_](https://github.com/nothings/stb) are [public domain](https://github.com/nothings/stb/blob/master/LICENSE)
- [_freetype_](https://gitlab.freedesktop.org/freetype/freetype) is under the [FreeType license or the GPL license](https://gitlab.freedesktop.org/freetype/freetype/-/blob/master/LICENSE.TXT)
- [_libogg_](https://gitlab.xiph.org/xiph/ogg) is under the [BSD license](https://gitlab.xiph.org/xiph/ogg/-/blob/master/COPYING)
- [_libvorbis_](https://gitlab.xiph.org/xiph/vorbis) is under the [BSD license](https://gitlab.xiph.org/xiph/vorbis/-/blob/master/COPYING)
- [_libflac_](https://gitlab.xiph.org/xiph/flac) is under the [BSD license](https://gitlab.xiph.org/xiph/flac/-/blob/master/COPYING.Xiph)
- [_minimp3_](https://github.com/lieff/minimp3) is under the [CC0 license](https://github.com/lieff/minimp3/blob/master/LICENSE)