-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Markdown'd readme, changelog, contributing and license files.
- Loading branch information
Showing
9 changed files
with
427 additions
and
714 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Contribution Guidelines | ||
|
||
You would like to see a feature implemented or a bug fixed in SFML? Great! Contributions to SFML are highly appreciated, be it in the form of general ideas, concrete suggestions or code patches. | ||
|
||
[A few guiding rules have been set up on the SFML website](http://www.sfml-dev.org/contribute.php) that you should be aware of before opening an Issue or Pull Request. They will help you focus on the important stuff and prevent you from losing (y)our time with requests that are out of SFML's scope, known issues, and so on. | ||
|
||
Those rules cover the general scope defined for this project, a coding style, and a precise procedure to report bugs or suggest new features. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# SFML | ||
|
||
SFML - Copyright (C) 2007-2017 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 SFML | ||
|
||
* _OpenAL-Soft_ is under the LGPL license | ||
* _libjpeg_ is public domain | ||
* _stb_image_ and _stb_image_write_ are public domain | ||
* _freetype_ is under the FreeType license or the GPL license | ||
* _libogg_ is under the BSD license | ||
* _libvorbis_ is under the BSD license | ||
* _libflac_ is under the BSD license |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# SFML - Simple and Fast Multimedia Library | ||
|
||
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 | ||
|
||
- Laurent Gomila - main developer (laurent@sfml-dev.org) | ||
- Marco Antognini - OS X developer (hiura@sfml-dev.org) | ||
- Jonathan De Wachter - Android developer (dewachter.jonathan@gmail.com) | ||
- Jan Haller (bromeon@sfml-dev.org) | ||
- Stefan Schindler (tank@sfml-dev.org) | ||
- Lukas Dürrenberger (eXpl0it3r@sfml-dev.org) | ||
- binary1248 (binary1248@hotmail.com) | ||
- Artur Moreira (artturmoreira@gmail.com) | ||
- Mario Liebisch (mario@sfml-dev.org) | ||
|
||
## Download | ||
|
||
You can get the latest official release on [SFML's website](http://www.sfml-dev.org/download.php). You can also get the current development version from the [Git repository](https://github.com/SFML/SFML). | ||
|
||
## Install | ||
|
||
Follow the instructions of the [tutorials](http://www.sfml-dev.org/tutorials/), there is one for each platform/compiler that SFML supports. | ||
|
||
## Learn | ||
|
||
There are several places to learn SFML: | ||
|
||
* 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/) ([French](http://fr.sfml-dev.org/forums/)) | ||
|
||
## Contribute | ||
|
||
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](http://www.sfml-dev.org/contribute.php). |
Oops, something went wrong.