UnrealXR/raylib-python-cffi
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs, make clear different APIs and static/dynamic

Browse source
This commit is contained in:
electronstudio 2021-10-03 23:34:09 +01:00
parent 47c4d0d1b4
commit 9e17046408
49 changed files with 5467 additions and 17850 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/_sources/README.md.txt
View file

@ -14,32 +14,39 @@ statically link and use in non-free / proprietary / commercial projects!
We distribute a statically linked binary Raylib wheel:
pip3 install raylib
python3 -m pip install raylib
Problems may be caused by out of date pip:
python3 -m pip install --upgrade pip
Some platforms that _should_ be available: Windows 10 x64, MacOS 10.15 x64, Linux Ubuntu1804 x64.
If yours isn't available then pip will attempt to build from source, so you will need to have Raylib development libs installed.
If yours isn't available then pip will attempt to build from source, in which case you will need to have Raylib development libs installed, e.g.
using homebrew, apt, etc.
[If it doesn't work, build from source](BUILDING.md)
There is now a separate dynamic version of this binding:
python3 -m pip install raylib_dynamic
[Read this before using raylib_dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html)
# How to use
There are three different ways of using this binding. You only need to pick one method, but you
There are two different ways of using this binding. You only need to pick one method, but you
can combine two methods in one program if you want to.
### If you are familiar with C coding and the Raylib C library and you want to use an exact copy of the C API
Use [raylib.static](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
Use [the C API](https://electronstudio.github.io/raylib-python-cffi/raylib.html).
### If you prefer a slightly more Pythonistic API and don't mind it might be slightly slower
Use [raylib.pyray](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
Use [the Python API](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
### If you insist on dynamic bindings and don't care that they are slower and less safe
Use [raylib.dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html).