Skip to content

Commit 64e5995

Browse files
update docs
1 parent d167b1f commit 64e5995

File tree

11 files changed

+60
-10
lines changed

11 files changed

+60
-10
lines changed

BUILDING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Building from source
2+
13
## Have Pip build from source
24

35
Useful if the binaries don't work on your system.
@@ -49,7 +51,11 @@ To build a binary wheel distribution:
4951
pip3 install wheel
5052
python setup.py bdist_wheel
5153

52-
and install it:
54+
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
55+
56+
python3 setup_dynamic.py bdist_wheel
57+
58+
Then install it:
5359

5460
pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
5561

@@ -104,7 +110,11 @@ To build a binary wheel distribution:
104110
pip3 install wheel
105111
python3 setup.py bdist_wheel
106112

107-
and install it:
113+
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
114+
115+
python3 setup_dynamic.py bdist_wheel
116+
117+
Then install it:
108118

109119
pip3 install dist/raylib*.whl
110120

1.15 KB
Binary file not shown.
703 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

docs-src/dynamic.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ raylib.dynamic
33

44
CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.
55

6+
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
7+
68
Currently the github version may include bundled DLLs in ``raylib/dynamic`` but the pypi version requires a system installed Raylib.
79
You can put your own DLLs in ``raylib/dynamic`` if you prefer.
810

911
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
1012
always be used instead of the bundled DLLs.
1113

12-
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
14+
If you want to build your own wheel with just raylib.dynamic and not even attempt to compile the static libraries,
15+
the command is::
16+
17+
python3 setup_dynamic.py bdist_wheel
18+
19+
1320

1421
.. warning::
1522

docs/BUILDING.html

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,11 @@ <h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title
224224
python setup.py bdist_wheel
225225
</pre></div>
226226
</div>
227-
<p>and install it:</p>
227+
<p>Alternatively, if you don’t want the static binaries and just want to use DLLs with raylib.dynamic:</p>
228+
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 setup_dynamic.py bdist_wheel
229+
</pre></div>
230+
</div>
231+
<p>Then install it:</p>
228232
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
229233
</pre></div>
230234
</div>
@@ -276,7 +280,11 @@ <h3>Linux etc manual build<a class="headerlink" href="#linux-etc-manual-build" t
276280
python3 setup.py bdist_wheel
277281
</pre></div>
278282
</div>
279-
<p>and install it:</p>
283+
<p>Alternatively, if you don’t want the static binaries and just want to use DLLs with raylib.dynamic:</p>
284+
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 setup_dynamic.py bdist_wheel
285+
</pre></div>
286+
</div>
287+
<p>Then install it:</p>
280288
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pip3 install dist/raylib*.whl
281289
</pre></div>
282290
</div>

docs/_sources/BUILDING.md.txt

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,11 @@ To build a binary wheel distribution:
5151
pip3 install wheel
5252
python setup.py bdist_wheel
5353

54-
and install it:
54+
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
55+
56+
python3 setup_dynamic.py bdist_wheel
57+
58+
Then install it:
5559

5660
pip3 install dist\raylib-3.7.0-cp37-cp37m-win_amd64.whl
5761

@@ -106,7 +110,11 @@ To build a binary wheel distribution:
106110
pip3 install wheel
107111
python3 setup.py bdist_wheel
108112

109-
and install it:
113+
Alternatively, if you don't want the static binaries and just want to use DLLs with raylib.dynamic:
114+
115+
python3 setup_dynamic.py bdist_wheel
116+
117+
Then install it:
110118

111119
pip3 install dist/raylib*.whl
112120

docs/_sources/dynamic.rst.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ raylib.dynamic
33

44
CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.
55

6+
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
7+
68
Currently the github version may include bundled DLLs in ``raylib/dynamic`` but the pypi version requires a system installed Raylib.
79
You can put your own DLLs in ``raylib/dynamic`` if you prefer.
810

911
If your system already has the Raylib library installed, you can set the environment variable ``USE_EXTERNAL_RAYLIB`` and it will
1012
always be used instead of the bundled DLLs.
1113

12-
See https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py for how to use.
14+
If you want to build your own wheel with just raylib.dynamic and not even attempt to compile the static libraries,
15+
the command is::
16+
17+
python3 setup_dynamic.py bdist_wheel
18+
19+
1320

1421
.. warning::
1522

docs/dynamic.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,16 @@
172172
<div class="section" id="raylib-dynamic">
173173
<h1>raylib.dynamic<a class="headerlink" href="#raylib-dynamic" title="Permalink to this headline"></a></h1>
174174
<p>CFFI ABI dynamic bindings exist in order to avoid the need to compile a C extension module.</p>
175+
<p>See <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py">https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py</a> for how to use.</p>
175176
<p>Currently the github version may include bundled DLLs in <code class="docutils literal notranslate"><span class="pre">raylib/dynamic</span></code> but the pypi version requires a system installed Raylib.
176177
You can put your own DLLs in <code class="docutils literal notranslate"><span class="pre">raylib/dynamic</span></code> if you prefer.</p>
177178
<p>If your system already has the Raylib library installed, you can set the environment variable <code class="docutils literal notranslate"><span class="pre">USE_EXTERNAL_RAYLIB</span></code> and it will
178179
always be used instead of the bundled DLLs.</p>
179-
<p>See <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py">https://github.com/electronstudio/raylib-python-cffi/blob/master/test_static.py</a> for how to use.</p>
180+
<p>If you want to build your own wheel with just raylib.dynamic and not even attempt to compile the static libraries,
181+
the command is:</p>
182+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="n">setup_dynamic</span><span class="o">.</span><span class="n">py</span> <span class="n">bdist_wheel</span>
183+
</pre></div>
184+
</div>
180185
<div class="admonition warning">
181186
<p class="admonition-title">Warning</p>
182187
<p>There have been some weird failures with dynamic bindings and ctypes bindings before and often the

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)