fix docs/name

This commit is contained in:
electronstudio 2021-10-03 21:42:57 +01:00
parent 693657593b
commit 47c4d0d1b4
2 changed files with 43 additions and 42 deletions

View file

@ -1,42 +0,0 @@
raylib.dynamic
==============
CFFI ABI dynamic bindings avoid the need to compile a C extension module. They now been moved to a separate module::
python3 -m pip install raylib_dll
.. warning::
There have been some weird failures with dynamic bindings and ctypes bindings before and often the
failures are silent
so you dont even know. Also the static bindings are faster. Therefore I personally recommend the static ones.
But the dynamic bindings have the advantage that you don't need to compile anything to install. You just need a Raylib DLL.
API is exactly the same as the static one documented here. (Therefore you can't have both modules installed at once.) The only difference is you can't do::
from raylib import *
Instead you have to do::
from raylib import raylib as rl
Then you access the functions with ``rl.`` prefix. See
See https://github.com/electronstudio/raylib-python-cffi/blob/master/dynamic/test_dynamic.py for an example.
.. important::
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
always be used instead of the bundled DLLs.
.. note::
If you write a program using the ``rl.`` prefix on all the functions and then you decide you want to use
that same program with the static binding instead of the dynamic, you don't have to remove the ``rl``,
you can just do::
import raylib as rl

1
docs-src/dynamic.rst Symbolic link
View file

@ -0,0 +1 @@
../dynamic/README.rst

42
dynamic/README.rst Normal file
View file

@ -0,0 +1,42 @@
raylib.dynamic
==============
CFFI ABI dynamic bindings avoid the need to compile a C extension module. They now been moved to a separate module::
python3 -m pip install raylib_dynamic
.. warning::
There have been some weird failures with dynamic bindings and ctypes bindings before and often the
failures are silent
so you dont even know. Also the static bindings are faster. Therefore I personally recommend the static ones.
But the dynamic bindings have the advantage that you don't need to compile anything to install. You just need a Raylib DLL.
API is exactly the same as the static one documented here. (Therefore you can't have both modules installed at once.) The only difference is you can't do::
from raylib import *
Instead you have to do::
from raylib import raylib as rl
Then you access the functions with ``rl.`` prefix. See
See https://github.com/electronstudio/raylib-python-cffi/blob/master/dynamic/test_dynamic.py for an example.
.. important::
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
always be used instead of the bundled DLLs.
.. note::
If you write a program using the ``rl.`` prefix on all the functions and then you decide you want to use
that same program with the static binding instead of the dynamic, you don't have to remove the ``rl``,
you can just do::
import raylib as rl