summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorJames Cowgill <jcowgill@debian.org>2018-05-15 13:58:15 +0100
committerJames Cowgill <jcowgill@debian.org>2018-05-15 13:58:15 +0100
commitb175eed3ca950204c9b52fdcebc897f337b7bf19 (patch)
tree0f50d921750c957f11bda18abc83f9228d010902 /readme.md
parent31394fcd65a10f2d2c51c3d27afff5367bded901 (diff)
New upstream version 2.5.0+dfsg
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..b6f9de0
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,39 @@
+[![SFML logo](https://www.sfml-dev.org/images/logo.png)](https://www.sfml-dev.org)
+
+# 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)
+ - And many other members of the SFML community
+
+## 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).
+
+## Install
+
+Follow the instructions of the [tutorials](https://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](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/) ([French](https://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](https://www.sfml-dev.org/contribute.php).