Skip to content

Commit 9e17046

Browse files
improve docs, make clear different APIs and static/dynamic
1 parent 47c4d0d commit 9e17046

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+5460
-17843
lines changed

BUILDING.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ Build and install Raylib from the raylib-c directory.
5959

6060
To update the dynamic libs, download the official release,
6161
e.g. https://github.com/raysan5/raylib/releases/download/3.7.0/raylib-3.7.0_win64_msvc16.zip
62-
and extract ``raylib.dll`` into ``raylib/dynamic``. Delete the files for
63-
other platforms, unless you want them in your distribution.
62+
and extract ``raylib.dll`` into ``dynamic/raylib``.
6463

6564
To build a binary wheel distribution:
6665

@@ -111,7 +110,7 @@ Build and install Raylib from the raylib-c directory.
111110
sudo make install
112111

113112
.. note:: Optional: Build the Raylib shared libs, if you plan to use
114-
``raylib.dynamic`` binding.
113+
``raylib_dynamic`` binding.
115114

116115
::
117116

@@ -148,8 +147,8 @@ Build
148147

149148
::
150149

151-
rm raylib/dynamic/*.so*
152-
cp -P /usr/local/lib/libraylib.so* raylib/dynamic/
150+
rm dynamic/raylib/*.so*
151+
cp -P /usr/local/lib/libraylib.so* dynamic/raylib/
153152

154153
To build a binary wheel distribution:
155154

@@ -158,12 +157,6 @@ To build a binary wheel distribution:
158157
pip3 install wheel
159158
python3 setup.py bdist_wheel
160159

161-
Alternatively, if you don’t want the static binaries and just want to
162-
use DLLs with raylib.dynamic:
163-
164-
::
165-
166-
python3 setup_dynamic.py bdist_wheel
167160

168161
Then install it:
169162

@@ -183,8 +176,8 @@ To build a complete set of libs for Python 3.6, 3.7, 3.8 and 3.9:
183176
``./raylib/static/build_multi_linux.sh`` )
184177

185178
.. TODO::
186-
move the dynamic libs into a separate package rather than include
187-
them with every one.
179+
Separate the instructions for preparing the dynamic module
180+
from the instructions for building the static module!
188181

189182

190183

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,26 @@ using homebrew, apt, etc.
2727

2828
[If it doesn't work, build from source](BUILDING.md)
2929

30+
There is now a separate dynamic version of this binding:
31+
32+
python3 -m pip install raylib_dynamic
33+
34+
[Read this before using raylib_dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html)
3035

3136

3237
# How to use
3338

34-
There are three different ways of using this binding. You only need to pick one method, but you
39+
There are two different ways of using this binding. You only need to pick one method, but you
3540
can combine two methods in one program if you want to.
3641

3742
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
3843

39-
Use [raylib.static](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
44+
Use [the C API](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
4045

4146
### If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower
4247

43-
Use [raylib.pyray](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
44-
45-
### If you insist on dynamic bindings and don't care that they are slower and less safe
48+
Use [the Python API](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
4649

47-
Use [raylib.dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html).
4850

4951

5052

-165 Bytes
Binary file not shown.
820 Bytes
Binary file not shown.
1.64 KB
Binary file not shown.
-584 KB
Binary file not shown.
Binary file not shown.
64 Bytes
Binary file not shown.
69.1 KB
Binary file not shown.
36.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)