Skip to content

Commit d058903

Browse files
update docs
1 parent ef91af8 commit d058903

19 files changed

+725
-172
lines changed

BUILDING.rst

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,30 @@ Building from source
44
Have Pip build from source
55
--------------------------
66

7-
Useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
7+
This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
88

9-
Make sure Raylib is installed and then:
9+
First make sure Raylib is installed. On Linux/Mac it must include the pkg-config files. Best way to ensure this
10+
is to compile and install Raylib using CMake: https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux#build-raylib-using-cmake
11+
12+
::
13+
14+
cd raylib-4.0.0
15+
mkdir build
16+
cd build
17+
cmake -DWITH_PIC=on -DCMAKE_BUILD_TYPE=Release ..
18+
make
19+
sudo make install
20+
21+
22+
23+
Then ask Pip to build from source:
1024

1125
::
1226

1327
pip3 install --no-binary raylib --upgrade --force-reinstall raylib
1428

15-
Build from source manually
16-
--------------------------
29+
Or, Build from source manually
30+
------------------------------
1731

1832
Useful if the Pip build doesn’t work and you want to debug it, or you want to contribute to the
1933
project.
@@ -22,7 +36,7 @@ project.
2236
If the Pip build doesn’t work, please submit a bug. (And if you have
2337
fixed it, a PR.)
2438

25-
Manual instructions follow, but see also how we actually build the wheels
39+
Manual instructions follow, but may be outdated, so see also how we actually build the wheels
2640
at https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml
2741

2842
Windows manual build
@@ -207,6 +221,10 @@ Build and install module.
207221
Raspberry Pi
208222
~~~~~~~~~~~~
209223

224+
Latest info: https://github.com/electronstudio/raylib-python-cffi/issues/55#issuecomment-1012629701
225+
226+
Old possibly out of date info that was written for RPi3 and Raylib 3 follows.
227+
210228
The integrated GPU hardware in a Raspberry Pi (“VideoCore”) is rather
211229
idiosyncratic, resulting in a complex set of software options. Probably
212230
the most interesting two options for Raylib applications are:

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,11 @@ Use [the C API](https://electronstudio.github.io/raylib-python-cffi/raylib.html)
6868

6969
Use [the Python API](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
7070

71+
# App showcase
7172

73+
[Tanki](https://github.com/pkulev/tanki)
7274

75+
Add your app here!
7376

7477
# RLZero
7578

create_stub_pyray.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ def ctype_to_python_type(t):
2727
return 'None'
2828
elif t == "long":
2929
return "int"
30+
elif t == "unsigned long long":
31+
return "int"
3032
elif t == "double":
3133
return "float"
3234
elif "char *" in t:

create_stub_static.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ def ctype_to_python_type(t):
3030
return 'None'
3131
elif t == "long":
3232
return "int"
33+
elif t == "unsigned long long":
34+
return "int"
3335
elif t == "double":
3436
return "float"
3537
elif "char *" in t:

docs/BUILDING.html

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,11 @@
3636
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
3737
<p class="caption"><span class="caption-text">Contents:</span></p>
3838
<ul class="current">
39-
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 4.0-dev</a></li>
39+
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 4.0.0</a></li>
4040
<li class="toctree-l1"><a class="reference internal" href="README.html#quickstart">Quickstart</a></li>
4141
<li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
4242
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
43+
<li class="toctree-l1"><a class="reference internal" href="README.html#app-showcase">App showcase</a></li>
4344
<li class="toctree-l1"><a class="reference internal" href="README.html#rlzero">RLZero</a></li>
4445
<li class="toctree-l1"><a class="reference internal" href="README.html#help-wanted">Help wanted</a></li>
4546
<li class="toctree-l1"><a class="reference internal" href="README.html#license-updated">License (updated)</a></li>
@@ -51,7 +52,7 @@
5152
<li class="toctree-l1"><a class="reference internal" href="dynamic.html">Dynamic Bindings</a></li>
5253
<li class="toctree-l1 current"><a class="current reference internal" href="#">Building from source</a><ul>
5354
<li class="toctree-l2"><a class="reference internal" href="#have-pip-build-from-source">Have Pip build from source</a></li>
54-
<li class="toctree-l2"><a class="reference internal" href="#build-from-source-manually">Build from source manually</a><ul>
55+
<li class="toctree-l2"><a class="reference internal" href="#or-build-from-source-manually">Or, Build from source manually</a><ul>
5556
<li class="toctree-l3"><a class="reference internal" href="#windows-manual-build">Windows manual build</a></li>
5657
<li class="toctree-l3"><a class="reference internal" href="#linux-manual-build">Linux manual build</a></li>
5758
<li class="toctree-l3"><a class="reference internal" href="#macos-manual-build">Macos manual build</a></li>
@@ -90,22 +91,32 @@
9091
<h1>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h1>
9192
<div class="section" id="have-pip-build-from-source">
9293
<h2>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h2>
93-
<p>Useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.</p>
94-
<p>Make sure Raylib is installed and then:</p>
94+
<p>This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.</p>
95+
<p>First make sure Raylib is installed. On Linux/Mac it must include the pkg-config files. Best way to ensure this
96+
is to compile and install Raylib using CMake: <a class="reference external" href="https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux#build-raylib-using-cmake">https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux#build-raylib-using-cmake</a></p>
97+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">raylib</span><span class="o">-</span><span class="mf">4.0</span><span class="o">.</span><span class="mi">0</span>
98+
<span class="n">mkdir</span> <span class="n">build</span>
99+
<span class="n">cd</span> <span class="n">build</span>
100+
<span class="n">cmake</span> <span class="o">-</span><span class="n">DWITH_PIC</span><span class="o">=</span><span class="n">on</span> <span class="o">-</span><span class="n">DCMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> <span class="o">..</span>
101+
<span class="n">make</span>
102+
<span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
103+
</pre></div>
104+
</div>
105+
<p>Then ask Pip to build from source:</p>
95106
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">binary</span> <span class="n">raylib</span> <span class="o">--</span><span class="n">upgrade</span> <span class="o">--</span><span class="n">force</span><span class="o">-</span><span class="n">reinstall</span> <span class="n">raylib</span>
96107
</pre></div>
97108
</div>
98109
</div>
99-
<div class="section" id="build-from-source-manually">
100-
<h2>Build from source manually<a class="headerlink" href="#build-from-source-manually" title="Permalink to this headline"></a></h2>
110+
<div class="section" id="or-build-from-source-manually">
111+
<h2>Or, Build from source manually<a class="headerlink" href="#or-build-from-source-manually" title="Permalink to this headline"></a></h2>
101112
<p>Useful if the Pip build doesn’t work and you want to debug it, or you want to contribute to the
102113
project.</p>
103114
<div class="admonition attention">
104115
<p class="admonition-title">Attention</p>
105116
<p>If the Pip build doesn’t work, please submit a bug. (And if you have
106117
fixed it, a PR.)</p>
107118
</div>
108-
<p>Manual instructions follow, but see also how we actually build the wheels
119+
<p>Manual instructions follow, but may be outdated, so see also how we actually build the wheels
109120
at <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml">https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml</a></p>
110121
<div class="section" id="windows-manual-build">
111122
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h3>
@@ -252,6 +263,8 @@ <h3>Macos manual build<a class="headerlink" href="#macos-manual-build" title="Pe
252263
</div>
253264
<div class="section" id="raspberry-pi">
254265
<h3>Raspberry Pi<a class="headerlink" href="#raspberry-pi" title="Permalink to this headline"></a></h3>
266+
<p>Latest info: <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues/55#issuecomment-1012629701">https://github.com/electronstudio/raylib-python-cffi/issues/55#issuecomment-1012629701</a></p>
267+
<p>Old possibly out of date info that was written for RPi3 and Raylib 3 follows.</p>
255268
<p>The integrated GPU hardware in a Raspberry Pi (“VideoCore”) is rather
256269
idiosyncratic, resulting in a complex set of software options. Probably
257270
the most interesting two options for Raylib applications are:</p>

docs/README.html

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Python Bindings for Raylib 4.0-dev &mdash; Raylib Python documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
6+
<title>Python Bindings for Raylib 4.0.0 &mdash; Raylib Python documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -37,7 +37,7 @@
3737
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
3838
<p class="caption"><span class="caption-text">Contents:</span></p>
3939
<ul class="current">
40-
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 4.0-dev</a></li>
40+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 4.0.0</a></li>
4141
<li class="toctree-l1"><a class="reference internal" href="#quickstart">Quickstart</a></li>
4242
<li class="toctree-l1"><a class="reference internal" href="#installation">Installation</a><ul>
4343
<li class="toctree-l2"><a class="reference internal" href="#dynamic-binding-version">Dynamic binding version</a></li>
@@ -49,6 +49,7 @@
4949
<li class="toctree-l2"><a class="reference internal" href="#if-you-prefer-a-slightly-more-pythonistic-api-and-don-t-mind-it-might-be-slightly-slower">If you prefer a slightly more Pythonistic API and don’t mind it might be slightly slower</a></li>
5050
</ul>
5151
</li>
52+
<li class="toctree-l1"><a class="reference internal" href="#app-showcase">App showcase</a></li>
5253
<li class="toctree-l1"><a class="reference internal" href="#rlzero">RLZero</a></li>
5354
<li class="toctree-l1"><a class="reference internal" href="#help-wanted">Help wanted</a></li>
5455
<li class="toctree-l1"><a class="reference internal" href="#license-updated">License (updated)</a></li>
@@ -78,7 +79,7 @@
7879
<div role="navigation" aria-label="Page navigation">
7980
<ul class="wy-breadcrumbs">
8081
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
81-
<li>Python Bindings for Raylib 4.0-dev</li>
82+
<li>Python Bindings for Raylib 4.0.0</li>
8283
<li class="wy-breadcrumbs-aside">
8384
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
8485
</li>
@@ -88,8 +89,8 @@
8889
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
8990
<div itemprop="articleBody">
9091

91-
<div class="tex2jax_ignore mathjax_ignore section" id="python-bindings-for-raylib-4-0-dev">
92-
<h1>Python Bindings for Raylib 4.0-dev<a class="headerlink" href="#python-bindings-for-raylib-4-0-dev" title="Permalink to this headline"></a></h1>
92+
<div class="tex2jax_ignore mathjax_ignore section" id="python-bindings-for-raylib-4-0-0">
93+
<h1>Python Bindings for Raylib 4.0.0<a class="headerlink" href="#python-bindings-for-raylib-4-0-0" title="Permalink to this headline"></a></h1>
9394
<p>New CFFI API static bindings.</p>
9495
<ul class="simple">
9596
<li><p>Automatically generated to be as close as possible to
@@ -139,7 +140,7 @@ <h2>Dynamic binding version<a class="headerlink" href="#dynamic-binding-version"
139140
</div>
140141
<div class="section" id="beta-testing">
141142
<h2>Beta testing<a class="headerlink" href="#beta-testing" title="Permalink to this headline"></a></h2>
142-
<p>You can install an alpha or beta version by specifying the version number like this:</p>
143+
<p>You can install an alpha or beta version by specifying the exact version number like this:</p>
143144
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip install raylib==4.0a6
144145
</pre></div>
145146
</div>
@@ -157,6 +158,11 @@ <h2>If you prefer a slightly more Pythonistic API and don’t mind it might be s
157158
<p>Use <a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/pyray.html">the Python API</a>.</p>
158159
</div>
159160
</div>
161+
<div class="tex2jax_ignore mathjax_ignore section" id="app-showcase">
162+
<h1>App showcase<a class="headerlink" href="#app-showcase" title="Permalink to this headline"></a></h1>
163+
<p><a class="reference external" href="https://github.com/pkulev/tanki">Tanki</a></p>
164+
<p>Add your app here!</p>
165+
</div>
160166
<div class="tex2jax_ignore mathjax_ignore section" id="rlzero">
161167
<h1>RLZero<a class="headerlink" href="#rlzero" title="Permalink to this headline"></a></h1>
162168
<p>A related library (that is a work in progress!):</p>

docs/_sources/BUILDING.rst.txt

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,30 @@ Building from source
44
Have Pip build from source
55
--------------------------
66

7-
Useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
7+
This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
88

9-
Make sure Raylib is installed and then:
9+
First make sure Raylib is installed. On Linux/Mac it must include the pkg-config files. Best way to ensure this
10+
is to compile and install Raylib using CMake: https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux#build-raylib-using-cmake
11+
12+
::
13+
14+
cd raylib-4.0.0
15+
mkdir build
16+
cd build
17+
cmake -DWITH_PIC=on -DCMAKE_BUILD_TYPE=Release ..
18+
make
19+
sudo make install
20+
21+
22+
23+
Then ask Pip to build from source:
1024

1125
::
1226

1327
pip3 install --no-binary raylib --upgrade --force-reinstall raylib
1428

15-
Build from source manually
16-
--------------------------
29+
Or, Build from source manually
30+
------------------------------
1731

1832
Useful if the Pip build doesn’t work and you want to debug it, or you want to contribute to the
1933
project.
@@ -22,7 +36,7 @@ project.
2236
If the Pip build doesn’t work, please submit a bug. (And if you have
2337
fixed it, a PR.)
2438

25-
Manual instructions follow, but see also how we actually build the wheels
39+
Manual instructions follow, but may be outdated, so see also how we actually build the wheels
2640
at https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml
2741

2842
Windows manual build
@@ -207,6 +221,10 @@ Build and install module.
207221
Raspberry Pi
208222
~~~~~~~~~~~~
209223

224+
Latest info: https://github.com/electronstudio/raylib-python-cffi/issues/55#issuecomment-1012629701
225+
226+
Old possibly out of date info that was written for RPi3 and Raylib 3 follows.
227+
210228
The integrated GPU hardware in a Raspberry Pi (“VideoCore”) is rather
211229
idiosyncratic, resulting in a complex set of software options. Probably
212230
the most interesting two options for Raylib applications are:

docs/_sources/README.md.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Python Bindings for Raylib 4.0-dev
1+
# Python Bindings for Raylib 4.0.0
22

33
New CFFI API static bindings.
44
* Automatically generated to be as close as possible to
@@ -51,7 +51,7 @@ There is now a separate dynamic version of this binding:
5151

5252
## Beta testing
5353

54-
You can install an alpha or beta version by specifying the version number like this:
54+
You can install an alpha or beta version by specifying the exact version number like this:
5555

5656
python3 -m pip install raylib==4.0a6
5757

@@ -68,8 +68,11 @@ Use [the C API](https://electronstudio.github.io/raylib-python-cffi/raylib.html)
6868

6969
Use [the Python API](https://electronstudio.github.io/raylib-python-cffi/pyray.html).
7070

71+
# App showcase
7172

73+
[Tanki](https://github.com/pkulev/tanki)
7274

75+
Add your app here!
7376

7477
# RLZero
7578

docs/dynamic.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,11 @@
3737
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
3838
<p class="caption"><span class="caption-text">Contents:</span></p>
3939
<ul class="current">
40-
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 4.0-dev</a></li>
40+
<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 4.0.0</a></li>
4141
<li class="toctree-l1"><a class="reference internal" href="README.html#quickstart">Quickstart</a></li>
4242
<li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
4343
<li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
44+
<li class="toctree-l1"><a class="reference internal" href="README.html#app-showcase">App showcase</a></li>
4445
<li class="toctree-l1"><a class="reference internal" href="README.html#rlzero">RLZero</a></li>
4546
<li class="toctree-l1"><a class="reference internal" href="README.html#help-wanted">Help wanted</a></li>
4647
<li class="toctree-l1"><a class="reference internal" href="README.html#license-updated">License (updated)</a></li>

0 commit comments

Comments
 (0)