Skip to content

Commit e50b3b2

Browse files
update docs
1 parent 906a4f1 commit e50b3b2

File tree

6 files changed

+72
-8
lines changed

6 files changed

+72
-8
lines changed

BUILDING.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Raylib.
200200

201201
git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
202202

203-
Build and install Raylib from the raylib-c directory.
203+
Build Raylib from the raylib-c directory.
204204

205205
::
206206

2.51 KB
Binary file not shown.
3.61 KB
Binary file not shown.

docs/BUILDING.html

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
<li class="toctree-l2"><a class="reference internal" href="#build-from-source-manually">Build from source manually</a><ul>
5454
<li class="toctree-l3"><a class="reference internal" href="#windows-manual-build">Windows manual build</a></li>
5555
<li class="toctree-l3"><a class="reference internal" href="#linux-manual-build">Linux manual build</a></li>
56+
<li class="toctree-l3"><a class="reference internal" href="#macos-manual-build">Macos manual build</a></li>
5657
<li class="toctree-l3"><a class="reference internal" href="#raspberry-pi">Raspberry Pi</a></li>
5758
</ul>
5859
</li>
@@ -104,6 +105,8 @@ <h2>Build from source manually<a class="headerlink" href="#build-from-source-man
104105
<p>If the Pip build doesn’t work, please submit a bug. (And if you have
105106
fixed it, a PR.)</p>
106107
</div>
108+
<p>Manual instructions follow, but see also how we actually build the wheels
109+
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>
107110
<div class="section" id="windows-manual-build">
108111
<h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title="Permalink to this headline"></a></h3>
109112
<p>Clone this repo including submodules so you get correct version of
@@ -152,8 +155,7 @@ <h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title
152155
</div>
153156
<div class="section" id="linux-manual-build">
154157
<h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Permalink to this headline"></a></h3>
155-
<p>These instructions have been tested on Ubuntu 20.10 and 16.04. Mac
156-
should be very similar.</p>
158+
<p>These instructions have been tested on Ubuntu 20.10 and 16.04.</p>
157159
<p>Clone this repo including submodules so you get correct version of
158160
Raylib.</p>
159161
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="o">--</span><span class="n">recurse</span><span class="o">-</span><span class="n">submodules</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">electronstudio</span><span class="o">/</span><span class="n">raylib</span><span class="o">-</span><span class="n">python</span><span class="o">-</span><span class="n">cffi</span>
@@ -174,6 +176,7 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Pe
174176
<code class="docutils literal notranslate"><span class="pre">raylib.dynamic</span></code> binding.</p>
175177
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="o">*</span>
176178
<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">DBUILD_SHARED_LIBS</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>
179+
<span class="n">make</span>
177180
<span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
178181
</pre></div>
179182
</div>
@@ -234,7 +237,30 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Pe
234237
<div class="admonition-todo admonition" id="id1">
235238
<p class="admonition-title">Todo</p>
236239
<p>move the dynamic libs into a separate package rather than include
237-
them with every one.)</p>
240+
them with every one.</p>
241+
</div>
242+
</div>
243+
<div class="section" id="macos-manual-build">
244+
<h3>Macos manual build<a class="headerlink" href="#macos-manual-build" title="Permalink to this headline"></a></h3>
245+
<p>These instructions have been tested on Macos 10.14.</p>
246+
<p>Clone this repo including submodules so you get correct version of
247+
Raylib.</p>
248+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="o">--</span><span class="n">recurse</span><span class="o">-</span><span class="n">submodules</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">electronstudio</span><span class="o">/</span><span class="n">raylib</span><span class="o">-</span><span class="n">python</span><span class="o">-</span><span class="n">cffi</span>
249+
</pre></div>
250+
</div>
251+
<p>Build Raylib from the raylib-c directory.</p>
252+
<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="n">python</span><span class="o">-</span><span class="n">cffi</span><span class="o">/</span><span class="n">raylib</span><span class="o">-</span><span class="n">c</span><span class="o">/</span><span class="n">src</span>
253+
<span class="n">make</span>
254+
<span class="n">cd</span> <span class="o">../..</span>
255+
</pre></div>
256+
</div>
257+
<p>Build and install module.</p>
258+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">cffi</span>
259+
<span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="n">build</span> <span class="n">raylib</span><span class="o">/</span><span class="n">static</span><span class="o">/</span><span class="n">_raylib_cffi</span><span class="o">.*</span>
260+
<span class="n">python3</span> <span class="n">raylib</span><span class="o">/</span><span class="n">static</span><span class="o">/</span><span class="n">build</span><span class="o">.</span><span class="n">py</span>
261+
<span class="n">pip3</span> <span class="n">install</span> <span class="n">wheel</span>
262+
<span class="n">python3</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
263+
</pre></div>
238264
</div>
239265
</div>
240266
<div class="section" id="raspberry-pi">

docs/_sources/BUILDING.rst.txt

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ dynamic binding with your own dll*.
2323
If the Pip build doesn’t work, please submit a bug. (And if you have
2424
fixed it, a PR.)
2525

26+
Manual instructions follow, but see also how we actually build the wheels
27+
at https://github.com/electronstudio/raylib-python-cffi/blob/master/.github/workflows/build.yml
28+
2629
Windows manual build
2730
~~~~~~~~~~~~~~~~~~~~
2831

@@ -87,8 +90,7 @@ here.)
8790
Linux manual build
8891
~~~~~~~~~~~~~~~~~~~~~~
8992

90-
These instructions have been tested on Ubuntu 20.10 and 16.04. Mac
91-
should be very similar.
93+
These instructions have been tested on Ubuntu 20.10 and 16.04.
9294

9395
Clone this repo including submodules so you get correct version of
9496
Raylib.
@@ -115,6 +117,7 @@ Build and install Raylib from the raylib-c directory.
115117

116118
rm -rf *
117119
cmake -DWITH_PIC=on -DBUILD_SHARED_LIBS=on -DCMAKE_BUILD_TYPE=Release ..
120+
make
118121
sudo make install
119122

120123
::
@@ -181,7 +184,42 @@ To build a complete set of libs for Python 3.6, 3.7, 3.8 and 3.9:
181184

182185
.. TODO::
183186
move the dynamic libs into a separate package rather than include
184-
them with every one.)
187+
them with every one.
188+
189+
190+
191+
Macos manual build
192+
~~~~~~~~~~~~~~~~~~~~~~
193+
194+
These instructions have been tested on Macos 10.14.
195+
196+
Clone this repo including submodules so you get correct version of
197+
Raylib.
198+
199+
::
200+
201+
git clone --recurse-submodules https://github.com/electronstudio/raylib-python-cffi
202+
203+
Build Raylib from the raylib-c directory.
204+
205+
::
206+
207+
cd raylib-python-cffi/raylib-c/src
208+
make
209+
cd ../..
210+
211+
212+
Build and install module.
213+
214+
::
215+
216+
pip3 install cffi
217+
rm -rf build raylib/static/_raylib_cffi.*
218+
python3 raylib/static/build.py
219+
pip3 install wheel
220+
python3 setup.py install
221+
222+
185223

186224
Raspberry Pi
187225
~~~~~~~~~~~~

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)