Skip to content

Commit 7c72e50

Browse files
committed
Rewrote README file to be more concise and up-to-date
1 parent f38f106 commit 7c72e50

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

README.rst

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,27 @@
1-
About
2-
=====
3-
These are Python bindings for `SFML <http://www.sfml-dev.org/>`_, made available
4-
under the terms of the `zlib/libpng <http://opensource.org/licenses/Zlib>`_ license.
1+
This is version 2.3.2 of the official Python bindings for SFML, based on
2+
SFML 2.3.2, and is made available under the terms of the zlib/libpng
3+
license.
54

6-
By combining the strength of SFML with the ease of the Python language,
7-
we can provide an amazing tool to quickly build multimedia software.
5+
As for most of Python projects, the easiest way to get the latest stable
6+
version is through PyPi. Just issue the following command in a terminal::
87

9-
Getting the Code
10-
================
11-
After you've installed `Git <http://git-scm.com/downloads>`_, you may issue
12-
the following command to obtain the source::
8+
pip install pysfml
139

14-
git clone git@github.com:Sonkun/python-sfml.git
10+
You might want to work with the development version in which case you
11+
have to compile by yourself. First, obtain the source::
12+
13+
git clone https://github.com/Sonkun/python-sfml.git
1514
cd python-sfml
1615

17-
Resources
18-
=========
19-
* Website: http://python-sfml.org
20-
* Documentation: http://python-sfml.org/api/api_index.html
21-
* Github: https://github.com/Sonkun/python-sfml
22-
* Bug Tracker: http://github.com/Sonkun/python-sfml/issues
23-
* Wiki: https://github.com/Sonkun/python-sfml/wiki
16+
Then, compiling is simply a matter of `python setup.py install` in a
17+
terminal after you installed the dependencies which are Cython and SFML
18+
itself.
2419

25-
Contact Information
26-
===================
27-
Feel free to email us with any questions or concerns:
20+
Please visit the website for any complementary information on this
21+
project. Also, feel free to email us with any questions or concerns:
2822

2923
* `Jonathan De Wachter <mailto:dewachter.jonathan@gmail.com>`_
30-
* `Edwin Marshall <mailto:emarshall85@gmail.com>`_
24+
* `Edwin Marshall <mailto:emarshall85@gmail.com>`_
25+
26+
You're also encouraged to visit (and contribute) to the wiki which
27+
gathers various piece of code, tutorials, tips and tricks.

0 commit comments

Comments
 (0)