update docs
This commit is contained in:
richard
parent
e8de1d3b60
commit
e0201a29f8
14 changed files with 8908 additions and 716 deletions
|
|
@ -4,7 +4,7 @@ Building from source
|
|||
Have Pip build from source
|
||||
--------------------------
|
||||
|
||||
Useful if the binaries don’t work on your system.
|
||||
Useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
|
||||
|
||||
Make sure Raylib is installed and then:
|
||||
|
||||
|
|
@ -56,9 +56,7 @@ Build and install Raylib from the raylib-c directory.
|
|||
copy raylib\Release\raylib.lib ..\..
|
||||
cd ..\..
|
||||
|
||||
To update the dynamic libs, download the official release,
|
||||
e.g. https://github.com/raysan5/raylib/releases/download/3.7.0/raylib-3.7.0_win64_msvc16.zip
|
||||
and extract ``raylib.dll`` into ``dynamic/raylib``.
|
||||
|
||||
|
||||
To build a binary wheel distribution:
|
||||
|
||||
|
|
@ -69,12 +67,10 @@ To build a binary wheel distribution:
|
|||
pip3 install wheel
|
||||
python setup.py bdist_wheel
|
||||
|
||||
Alternatively, if you don’t want the static binaries and just want to
|
||||
use DLLs with raylib.dynamic:
|
||||
.. TODO::
|
||||
There's a hardcoded path (to the raylib header files) in `raylib/build.py` you will probably need to edit.
|
||||
Would be useful if some Windows user could figure out how to auto detect this.
|
||||
|
||||
::
|
||||
|
||||
python3 setup_dynamic.py bdist_wheel
|
||||
|
||||
Then install it:
|
||||
|
||||
|
|
@ -88,8 +84,6 @@ here.)
|
|||
Linux manual build
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
These instructions have been tested on Ubuntu 20.10 and 16.04.
|
||||
|
||||
Clone this repo including submodules so you get correct version of
|
||||
Raylib.
|
||||
|
||||
|
|
@ -99,6 +93,10 @@ Raylib.
|
|||
|
||||
Build and install Raylib from the raylib-c directory.
|
||||
|
||||
.. note::
|
||||
You can instead use a different version of Raylib you installed from elsewhere, and it should still
|
||||
work!
|
||||
|
||||
::
|
||||
|
||||
sudo apt install cmake libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev
|
||||
|
|
@ -123,17 +121,6 @@ Build and install Raylib from the raylib-c directory.
|
|||
cd ../..
|
||||
|
||||
|
||||
.. note:: Optional: Make a patched version of raylib header. (**Not necessary** if
|
||||
you’ve already got raylib_modifed.h from repo and haven’t changed
|
||||
anything.)
|
||||
|
||||
::
|
||||
|
||||
cd raylib
|
||||
cp raylib.h raylib_modified.h
|
||||
patch -p0 <raylib_modified.h.patch
|
||||
cd ..
|
||||
|
||||
Build
|
||||
|
||||
::
|
||||
|
|
@ -142,7 +129,7 @@ Build
|
|||
rm -rf build raylib/_raylib_cffi.*
|
||||
python3 raylib/build.py
|
||||
|
||||
.. note:: (Optional) To update the Linux dynamic libs (names will be different on other platfroms):
|
||||
.. note:: (Optional) To update the Linux dynamic libs (names will be different on other platforms):
|
||||
|
||||
::
|
||||
|
||||
|
|
@ -196,10 +183,13 @@ Build and install Raylib from the raylib-c directory.
|
|||
|
||||
::
|
||||
|
||||
cd raylib-python-cffi/raylib-c/src
|
||||
make
|
||||
sudo cp libraylib.a /usr/local/lib/libraylib.a
|
||||
cd ../..
|
||||
cd raylib-python-cffi/raylib-c/
|
||||
mkdir build
|
||||
cd build
|
||||
cmake -DWITH_PIC=on -DCMAKE_BUILD_TYPE=Release ..
|
||||
make
|
||||
sudo make install
|
||||
cd ../..
|
||||
|
||||
|
||||
Build and install module.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,12 @@
|
|||
# Python Bindings for Raylib 3.7
|
||||
# Python Bindings for Raylib 4.0-dev
|
||||
|
||||
New CFFI API static bindings. Automatically generated to be as close as possible to
|
||||
original Raylib. Faster, fewer bugs and easier to maintain than ctypes. Commercial-friendly license.
|
||||
Docstrings and auto-completion.
|
||||
New CFFI API static bindings.
|
||||
* Automatically generated to be as close as possible to
|
||||
original Raylib.
|
||||
* Faster, fewer bugs and easier to maintain than ctypes.
|
||||
* Commercial-friendly license.
|
||||
* Docstrings and auto-completion.
|
||||
* **Now includes extra libraries: raygui, rlgl and physac**
|
||||
|
||||
[Full documentation](http://electronstudio.github.io/raylib-python-cffi)
|
||||
|
||||
|
|
@ -22,7 +26,7 @@ Docstrings and auto-completion.
|
|||
|
||||
# Installation
|
||||
|
||||
First make sure you have latest pip installed:
|
||||
First make sure you have the latest pip installed:
|
||||
|
||||
python3 -m pip install --upgrade pip
|
||||
|
||||
|
|
@ -35,7 +39,7 @@ On most platforms it should install a binary wheel (Windows 10 x64, MacOS 10.15
|
|||
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, you can build manually.](BUILDING.md)
|
||||
[If it doesn't work, you can build manually.](BUILDING.rst)
|
||||
|
||||
## Dynamic binding version
|
||||
|
||||
|
|
@ -45,6 +49,12 @@ There is now a separate dynamic version of this binding:
|
|||
|
||||
[Read this before using raylib_dynamic](https://electronstudio.github.io/raylib-python-cffi/dynamic.html)
|
||||
|
||||
## Beta testing
|
||||
|
||||
You can install an alpha or beta version by specifying the version number like this:
|
||||
|
||||
python3 -m pip install raylib==4.0a6
|
||||
|
||||
|
||||
# How to use
|
||||
|
||||
|
|
|
|||
Reference in a new issue