From 1d05e82f25f34db1f9272d9edc8d0dc201a35bb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20D=C3=BCrrenberger?= Date: Sun, 11 Jul 2021 23:29:45 +0200 Subject: [PATCH] Use Markdown for the readme and license files --- CMakeLists.txt | 4 ++-- license.md | 15 +++++++++++++++ license.txt | 31 ------------------------------- readme.md | 34 ++++++++++++++++++++++++++++++++++ readme.txt | 42 ------------------------------------------ 5 files changed, 51 insertions(+), 75 deletions(-) create mode 100644 license.md delete mode 100644 license.txt create mode 100644 readme.md delete mode 100644 readme.txt diff --git a/CMakeLists.txt b/CMakeLists.txt index 52899c5..72b638b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -72,5 +72,5 @@ install(DIRECTORY include DESTINATION . COMPONENT devel PATTERN ".svn" EXCLUDE) -install(FILES license.txt DESTINATION ${INSTALL_MISC_DIR}) -install(FILES readme.txt DESTINATION ${INSTALL_MISC_DIR}) +install(FILES license.md DESTINATION ${INSTALL_MISC_DIR}) +install(FILES readme.md DESTINATION ${INSTALL_MISC_DIR}) diff --git a/license.md b/license.md new file mode 100644 index 0000000..2e53858 --- /dev/null +++ b/license.md @@ -0,0 +1,15 @@ +# CSFML + +CSFML - Copyright (C) 2007-2021 Laurent Gomila - laurent@sfml-dev.org + +This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. + +Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + +## External libraries used by CSFML + + * _SFML_ is under the zlib/png license diff --git a/license.txt b/license.txt deleted file mode 100644 index 7d544f4..0000000 --- a/license.txt +++ /dev/null @@ -1,31 +0,0 @@ -CSFML ------ - -CSFML - Copyright (C) 2007-2021 Laurent Gomila - laurent@sfml-dev.org - -This software is provided 'as-is', without any express or -implied warranty. In no event will the authors be held -liable for any damages arising from the use of this software. - -Permission is granted to anyone to use this software for any purpose, -including commercial applications, and to alter it and redistribute -it freely, subject to the following restrictions: - -1. The origin of this software must not be misrepresented; - you must not claim that you wrote the original software. - If you use this software in a product, an acknowledgment - in the product documentation would be appreciated but - is not required. - -2. Altered source versions must be plainly marked as such, - and must not be misrepresented as being the original software. - -3. This notice may not be removed or altered from any - source distribution. - - - -External libraries used by CSFML --------------------------------- - -* SFML is under the zlib/png license diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6c45a67 --- /dev/null +++ b/readme.md @@ -0,0 +1,34 @@ +[![SFML logo](https://www.sfml-dev.org/images/logo.png)](https://www.sfml-dev.org) + +# CSFML - Simple and Fast Multimedia Library for C + +SFML is a simple, fast, cross-platform and object-oriented multimedia API. It provides access to windowing, graphics, audio and network. It is originally written in C++, and this project is its official binding for the C language. + +## Authors + + - Laurent Gomila - main developer (laurent@sfml-dev.org) + - Lukas Dürrenberger - active maintainer (eXpl0it3r@sfml-dev.org) + - Zachariah Brown (contact@zbrown.net) + +## Download + +You can get the latest official release on [SFML website](https://www.sfml-dev.org/download/csfml). You can also get the current development version from the [Git repository](https://github.com/SFML/CSFML). + +## Learn + +There is no tutorial for CSFML, but since it's a binding you can use the C++ resources: + + * The [official tutorials](https://www.sfml-dev.org/tutorials/) + * The [online API documentation](https://www.sfml-dev.org/documentation/) + * The [community wiki](https://github.com/SFML/SFML/wiki/) + * The [community forum](https://en.sfml-dev.org/forums/) (or [French](https://fr.sfml-dev.org/forums/) + +Of course, you can also find the CSFML API documentation in the SDK. + +## Building + +Set `SFML_DIR` to a directory containing the `SFMLConfig.cmake` file, usually located at `lib/cmake/SFML`. + +## Contribute + +SFML and CSFML are open-source projects, and they need your help to go on growing and improving. Don't hesitate to post suggestions or bug reports on [the forum](https://en.sfml-dev.org/forums/), or post new bugs/features requests on the [issue tracker](https://github.com/SFML/CSFML/issues/). You can even fork the project on GitHub, maintain your own version and send us pull requests periodically to merge your work. diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 8e304ca..0000000 --- a/readme.txt +++ /dev/null @@ -1,42 +0,0 @@ -CSFML - Simple and Fast Multimedia Library for C -================================================ - -SFML is a simple, fast, cross-platform and object-oriented multimedia API. It provides access to windowing, -graphics, audio and network. -It is originally written in C++, and this project is its official binding for the C language. - -Authors -------- - -Laurent Gomila - main developer (laurent@sfml-dev.org) -Zachariah Brown - active maintainer (contact@zbrown.net) - -Download --------- - -You can get the latest official release on SFML website (http://www.sfml-dev.org/download/csfml). -You can also get the current development version from the git repository (https://github.com/SFML/CSFML). - -Learn ------ - -There is no tutorial for CSFML, but since it's a binding you can use the C++ resources: -* The official tutorials (http://www.sfml-dev.org/tutorials/) -* The online API documentation (http://www.sfml-dev.org/documentation/) -* The community wiki (https://github.com/SFML/SFML/wiki/) -* The community forum (http://en.sfml-dev.org/forums/) (or http://fr.sfml-dev.org/forums/ for French people) - -Of course, you can also find the CSFML API documentation in the SDK. - -Building --------- - -The FindSFML.cmake script required by CMake to build CSFML, is located in SFML's cmake/Modules/ directory. - -Contribute ----------- - -SFML and CSFML are open-source projects, and they need your help to go on growing and improving. -Don't hesitate to post suggestions or bug reports on the forum (http://en.sfml-dev.org/forums/), -or post new bugs/features requests on the task tracker (https://github.com/SFML/CSFML/issues/). -You can even fork the project on GitHub, maintain your own version and send us pull requests periodically to merge your work.