mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-27 21:36:13 +01:00
Use Markdown for the readme and license files
This commit is contained in:
Lukas Dürrenberger committed
1 parent
c5a37aed84
commit
1d05e82f25
5 files changed
+51
-75
No files matched your search
+2
-2
@@ -72,5 +72,5 @@ install(DIRECTORY include
|
|||||||
DESTINATION .
|
DESTINATION .
|
||||||
COMPONENT devel
|
COMPONENT devel
|
||||||
PATTERN ".svn" EXCLUDE)
|
PATTERN ".svn" EXCLUDE)
|
||||||
install(FILES license.txt DESTINATION ${INSTALL_MISC_DIR})
|
install(FILES license.md DESTINATION ${INSTALL_MISC_DIR})
|
||||||
install(FILES readme.txt DESTINATION ${INSTALL_MISC_DIR})
|
install(FILES readme.md DESTINATION ${INSTALL_MISC_DIR})
|
||||||
+15
@@ -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
|
||||||
-31
@@ -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
|
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
[](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.
|
||||||
-42
@@ -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.
|
|
||||||
Reference in new issue
Block a user