diff --git a/readme.txt b/readme.txt index b0f6c68bb..07785e3c9 100644 --- a/readme.txt +++ b/readme.txt @@ -1,35 +1,41 @@ -= SFML - Simple and Fast Multimedia Library +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 +Authors +------- Laurent Gomila - main developer (laurent.gom@gmail.com) Marco Antognini - OS X developer (antognini.marco@gmail.com) -== Download +Download +-------- -You can get the latest official release on {SFML website}[http://www.sfml-dev.org/download.php]. -You can also get the current development version from the {git repository}[https://github.com/LaurentGomila/SFML]. +You can get the latest official release on SFML website (http://www.sfml-dev.org/download.php). +You can also get the current development version from the git repository (https://github.com/LaurentGomila/SFML). -== Install +Install +------- -Follow the instructions of the {tutorials}[http://www.sfml-dev.org/tutorials/], there is one for each platform/compiler that SFML supports. +Follow the instructions of the tutorials (http://www.sfml-dev.org/tutorials/), there is one for each platform/compiler that SFML supports. -== Learn +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/LaurentGomila/SFML/wiki/] -* The community {forum}[http://www.sfml-dev.org/forum/] +* 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/LaurentGomila/SFML/wiki/) +* The community forum (http://www.sfml-dev.org/forum/) -== Contribute +Contribute +---------- SFML is an open-source project, and it needs your help to go on growing and improving. -Don't hesitate to post suggestions or bug reports on the {forum}[http://www.sfml-dev.org/forum/], -submit patches by e-mail, or post new bugs/features requests on the {task tracker}[https://github.com/LaurentGomila/SFML/issues/]. +Don't hesitate to post suggestions or bug reports on the forum (http://www.sfml-dev.org/forum/), +submit patches by e-mail, or post new bugs/features requests on the{task tracker (https://github.com/LaurentGomila/SFML/issues/). You can even fork the project on github, maintain your own version and send us pull requests periodically to merge your work.