Skip to content

Commit 7af2922

Browse files
update docs
1 parent 57da96d commit 7af2922

File tree

7 files changed

+48
-45
lines changed

7 files changed

+48
-45
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Then install
3737
python3 -m pip install setuptools
3838
python3 -m pip install raylib
3939

40-
On most platforms it should install a binary wheel (Windows 10 x64, MacOS 10.15 x64, Linux Ubuntu1804 x64).
40+
On most platforms it should install a binary wheel (Windows 10 x64, MacOS 12 x64/arm64, Linux Ubuntu2004 x64/arm64).
4141

4242
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.
4343
using homebrew, apt, etc.
@@ -158,7 +158,7 @@ If you need more performance, do in this order:
158158
in your update loop
159159
and then only convert them to C data structures when you have to call the C functions for drawing.
160160

161-
3. The raylib.* functions are potentially 1.5x faster than the pyray.* equivalents, so if you need a tiny bit more performance
161+
3. The raylib.* functions are potentially *slightly* faster than the pyray.* equivalents, so if you need a tiny bit more performance
162162
you can switch your inner loop functions to these.
163163

164164
4. There is a version of Python that is faster than Pypy: GraalPy. However it's not fully compatible with all Python

RPI.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Raspberry Pi
22
====================
33

4-
Please use Raspberry Pi OS Bullseye. Older OSes are not tested.
4+
Please use Raspberry Pi OS Bookworm. Bullseye should also work. Older OSes are not tested.
55

66
Option 1: Binary wheel
77
----------------------
@@ -10,7 +10,7 @@ We have published binary wheels compiled for 64-bit Raspberry OS Bullseye in X11
1010

1111
::
1212

13-
python -m pip install raylib
13+
python -m pip install --break-system-packages raylib
1414

1515
If it doesn't work, or you're not on Bullseye, or you're 32 bit, or if you want to use Raylib in ``PLATFORM_DRM`` mode, you will need to compile your own raylib. See below.
1616
For full instructions on this, see https://github.com/raysan5/raylib/wiki/Working-on-Raspberry-Pi . If you need help with this ask Raylib.
@@ -22,6 +22,8 @@ This should work for everyone.
2222

2323
::
2424

25+
sudo apt update
26+
sudo python3-pip cmake libegl1-mesa-dev libgbm-dev libgles2-mesa-dev libdrm-dev libglfw3-dev
2527
git clone https://github.com/raysan5/raylib.git --branch 5.0 --single-branch
2628
cd raylib
2729
mkdir build
@@ -30,24 +32,24 @@ This should work for everyone.
3032
cmake -DPLATFORM="Desktop" -DOPENGL_VERSION=2.1 -DBUILD_EXAMPLES=OFF -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
3133
make
3234
sudo make install
35+
sudo cp -r ../src/external/glfw/include/GLFW /usr/local/include/
3336

3437
Then have pip compile and install the wheel:
3538

3639
::
3740

38-
sudo apt update
39-
sudo apt install python3-pip
40-
pip3 install setuptools
41-
pip3 install --no-cache-dir --no-binary raylib --upgrade --force-reinstall raylib==5.0.0.2
41+
python -m pip install --break-system-packages setuptools
42+
python -m pip install --no-cache-dir --no-binary raylib --upgrade --force-reinstall --break-system-packages raylib==5.0.0.3
4243

4344
Option 3: Compile Raylib from source DRM mode
4445
---------------------------------------------
4546

46-
As far as I can tell, Raylib DRM is broken. It doesn't work on my Pi. However, if you want to compile it and
47-
give it a go, these are the commands:
47+
This seems to work on Raspberry Pi 4. Note you must not be running X11 when you run your programs.
4848

4949
::
5050

51+
sudo apt update
52+
sudo python3-pip cmake libegl1-mesa-dev libgbm-dev libgles2-mesa-dev libdrm-dev libglfw3-dev
5153
git clone https://github.com/raysan5/raylib.git --branch 5.0 --single-branch
5254
cd raylib
5355
mkdir build
@@ -56,15 +58,14 @@ give it a go, these are the commands:
5658
cmake -DPLATFORM="DRM" -DBUILD_EXAMPLES=OFF -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
5759
make
5860
sudo make install
61+
sudo cp -r ../src/external/glfw/include/GLFW /usr/local/include/
5962
6063
Then have pip compile and install the wheel with some extra linker flags:
6164

6265
::
6366

64-
sudo apt update
65-
sudo apt install python3-pip
66-
pip3 install setuptools
67-
LDFLAGS="-lgbm -ldrm -lEGL" pip3 install --no-cache-dir --no-binary raylib --upgrade --force-reinstall raylib==5.0.0.2
67+
python -m pip install --break-system-packages setuptools
68+
LDFLAGS="-lgbm -ldrm -lEGL" pip3 install --no-cache-dir --no-binary raylib --upgrade --force-reinstall --break-system-packages raylib==5.0.0.3
6869

6970

7071

docs/README.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Link to this h
143143
python3 -m pip install raylib
144144
</pre></div>
145145
</div>
146-
<p>On most platforms it should install a binary wheel (Windows 10 x64, MacOS 10.15 x64, Linux Ubuntu1804 x64).</p>
146+
<p>On most platforms it should install a binary wheel (Windows 10 x64, MacOS 12 x64/arm64, Linux Ubuntu2004 x64/arm64).</p>
147147
<p>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.
148148
using homebrew, apt, etc.</p>
149149
<section id="raspberry-pi">
@@ -255,7 +255,7 @@ <h1>Performance<a class="headerlink" href="#performance" title="Link to this hea
255255
<li><p>Every call to C is costly, so it’s slightly faster if you use Python data structures and functions when calculating
256256
in your update loop
257257
and then only convert them to C data structures when you have to call the C functions for drawing.</p></li>
258-
<li><p>The raylib.* functions are potentially 1.5x faster than the pyray.* equivalents, so if you need a tiny bit more performance
258+
<li><p>The raylib.* functions are potentially <em>slightly</em> faster than the pyray.* equivalents, so if you need a tiny bit more performance
259259
you can switch your inner loop functions to these.</p></li>
260260
<li><p>There is a version of Python that is faster than Pypy: GraalPy. However it’s not fully compatible with all Python
261261
packages. It doesn’t work with CFFI and so doesn’t work with this binding. But it <em>is</em> compatible with the

0 commit comments

Comments
 (0)