Skip to content

Commit 51d3ea4

Browse files
committed
Changes to the readme to give some additional build advice for windows and adds a section noting the incompatibility between pygame and pygame_sdl2.
1 parent 795941a commit 51d3ea4

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

Diff for: README.rst

+30
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,28 @@ and then build and install using::
137137
This assumes you have installed a version of Visual Studio that is
138138
appropriate for the version of Python you are using.
139139

140+
If you also want to install the python headers in a standard fashion
141+
to make an IDE's autocomplete work then you should try creating a
142+
python wheel. First grab the wheel package::
143+
144+
pip install wheel
145+
146+
Then use this command to build your wheel::
147+
148+
python setup.py sdist bdist_wheel
149+
150+
Finally, you will need to install your wheel from the dist
151+
sub-directory with pip. What it is called will depend on your version
152+
of python, the current version of the library and your platform.
153+
For example, here is a command to install a python 3.6 wheel,
154+
on 32bit windows::
155+
156+
pip install dist\pygame_sdl2-2.1.0-cp36-cp36m-win32.whl
157+
158+
You will also need to delete any currently installed version of
159+
pygame_sdl2 from your Lib/site-packages directory to re-install
160+
this way.
161+
140162
C Headers
141163
^^^^^^^^^
142164

@@ -152,6 +174,14 @@ function will be called. The following functions are exposed:
152174
* PySurface_AsSurface - Returns the SDL_Surface underlying a pygame_sdl2.Surface.
153175
* PySurface_New - Wraps an SDL_Surface in a new pygame_sdl2.Surface.
154176

177+
Pygame incompatibility
178+
----------------------
179+
180+
Pygame_sdl2 is designed as a complete replacement for pygame.
181+
182+
If you try to use both the `pygame_sdl2` and `pygame` libraries in the same program
183+
you may encounter errors; such as library import failures in frozen programs.
184+
155185

156186
Contributing
157187
------------

0 commit comments

Comments
 (0)