Skip to content

Commit 32061da

Browse files
electronstudioelectronstudio
committed
update docs
1 parent 4bdd922 commit 32061da

File tree

4 files changed

+39
-18
lines changed

4 files changed

+39
-18
lines changed

‎README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ original Raylib.
2424

2525
# Quickstart
2626

27-
`pip3 install raylib==5.5.0.0`
27+
`pip3 install raylib==5.5.0.2 --break-system-packages`
2828
```python
2929
from pyray import *
3030
init_window(800, 450, "Hello")
@@ -38,14 +38,19 @@ close_window()
3838

3939
# Installation
4040

41-
First make sure you have the latest pip installed:
41+
If you are on a modern Linux you will probably want to create a venv:
42+
43+
python3 -m venv venv
44+
source venv/bin/activate
45+
46+
Then make sure you have the latest pip installed:
4247

4348
python3 -m pip install --upgrade pip
4449

4550
Then install
4651

4752
python3 -m pip install setuptools
48-
python3 -m pip install raylib==5.5.0.0
53+
python3 -m pip install raylib==5.5.0.2
4954

5055
On most platforms it should install a binary wheel. If yours isn't available then pip will attempt to build from
5156
source, in which case you will need to have Raylib development libs installed, e.g.
@@ -67,7 +72,7 @@ Older MacOS requires building from source but this is usually simple:
6772

6873
brew install pkg-config
6974
brew install raylib
70-
python3 -m pip install raylib==5.5.0.0
75+
python3 -m pip install raylib==5.5.0.2
7176

7277
(I do have binaries for arm64 MacOS 11, 12 and 13 but I have no way of testing they work, so post an issue
7378
if you want to test them.)
@@ -181,7 +186,7 @@ Point your browser to http://localhost:8000
181186
Some features may not work, so you can disable them like this:
182187

183188
```python
184-
if platform.system() != "Emscripten": # audio does not work on current version of emscripten
189+
if platform.system() != "Emscripten": # audio may not work on current version of emscripten
185190
init_audio_device()
186191
```
187192

‎docs/README.html

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,10 @@ <h2>Backends: Desktop, SDL, DRM, Web<a class="headerlink" href="#backends-deskto
123123
</section>
124124
<section id="platforms-windows-mac-linux-raspberry-pi-web">
125125
<h2>Platforms: Windows, Mac, Linux, Raspberry Pi, Web<a class="headerlink" href="#platforms-windows-mac-linux-raspberry-pi-web" title="Link to this heading"></a></h2>
126+
<p><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/raylib" /></p>
126127
<p>Chatroom: <a class="reference external" href="https://discord.gg/fKDwt85aX6">Discord</a></p>
127-
<p><a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues/155">HELP WANTED: writing examples</a></p>
128+
<p>HELP WANTED: <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues/155">writing examples</a></p>
129+
<p>Features:</p>
128130
<ul class="simple">
129131
<li><p>CFFI API static bindings.</p></li>
130132
<li><p>Automatically generated to be as close as possible to
@@ -139,7 +141,7 @@ <h2>Platforms: Windows, Mac, Linux, Raspberry Pi, Web<a class="headerlink" href=
139141
</section>
140142
<section id="quickstart">
141143
<h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this heading"></a></h1>
142-
<p><code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">raylib==5.5.0.0</span></code></p>
144+
<p><code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">raylib==5.5.0.2</span> <span class="pre">--break-system-packages</span></code></p>
143145
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pyray</span> <span class="kn">import</span> <span class="o">*</span>
144146
<span class="n">init_window</span><span class="p">(</span><span class="mi">800</span><span class="p">,</span> <span class="mi">450</span><span class="p">,</span> <span class="s2">&quot;Hello&quot;</span><span class="p">)</span>
145147
<span class="k">while</span> <span class="ow">not</span> <span class="n">window_should_close</span><span class="p">():</span>
@@ -153,13 +155,18 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this headi
153155
</section>
154156
<section id="installation">
155157
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
156-
<p>First make sure you have the latest pip installed:</p>
158+
<p>If you are on a modern Linux you will probably want to create a venv:</p>
159+
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m venv venv
160+
source venv/bin/activate
161+
</pre></div>
162+
</div>
163+
<p>Then make sure you have the latest pip installed:</p>
157164
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip install --upgrade pip
158165
</pre></div>
159166
</div>
160167
<p>Then install</p>
161168
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip install setuptools
162-
python3 -m pip install raylib==5.5.0.0
169+
python3 -m pip install raylib==5.5.0.2
163170
</pre></div>
164171
</div>
165172
<p>On most platforms it should install a binary wheel. If yours isn’t available then pip will attempt to build from
@@ -180,7 +187,7 @@ <h2>MacOS<a class="headerlink" href="#macos" title="Link to this heading"></a
180187
<p>Older MacOS requires building from source but this is usually simple:</p>
181188
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>brew install pkg-config
182189
brew install raylib
183-
python3 -m pip install raylib==5.5.0.0
190+
python3 -m pip install raylib==5.5.0.2
184191
</pre></div>
185192
</div>
186193
<p>(I do have binaries for arm64 MacOS 11, 12 and 13 but I have no way of testing they work, so post an issue
@@ -286,7 +293,7 @@ <h1>Running in a web browser<a class="headerlink" href="#running-in-a-web-browse
286293
</div>
287294
<p>Point your browser to http://localhost:8000</p>
288295
<p>Some features may not work, so you can disable them like this:</p>
289-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">!=</span> <span class="s2">&quot;Emscripten&quot;</span><span class="p">:</span> <span class="c1"># audio does not work on current version of emscripten</span>
296+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">!=</span> <span class="s2">&quot;Emscripten&quot;</span><span class="p">:</span> <span class="c1"># audio may not work on current version of emscripten</span>
290297
<span class="n">init_audio_device</span><span class="p">()</span>
291298
</pre></div>
292299
</div>

‎docs/_sources/README.md.txt

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@
33
## Backends: Desktop, SDL, DRM, Web
44
## Platforms: Windows, Mac, Linux, Raspberry Pi, Web
55

6+
![PyPI - Downloads](https://img.shields.io/pypi/dm/raylib)
7+
68
Chatroom: [Discord](https://discord.gg/fKDwt85aX6)
79

8-
[HELP WANTED: writing examples](https://github.com/electronstudio/raylib-python-cffi/issues/155)
10+
HELP WANTED: [writing examples](https://github.com/electronstudio/raylib-python-cffi/issues/155)
11+
12+
Features:
913

1014
* CFFI API static bindings.
1115
* Automatically generated to be as close as possible to
@@ -20,7 +24,7 @@ original Raylib.
2024

2125
# Quickstart
2226

23-
`pip3 install raylib==5.5.0.0`
27+
`pip3 install raylib==5.5.0.2 --break-system-packages`
2428
```python
2529
from pyray import *
2630
init_window(800, 450, "Hello")
@@ -34,14 +38,19 @@ close_window()
3438

3539
# Installation
3640

37-
First make sure you have the latest pip installed:
41+
If you are on a modern Linux you will probably want to create a venv:
42+
43+
python3 -m venv venv
44+
source venv/bin/activate
45+
46+
Then make sure you have the latest pip installed:
3847

3948
python3 -m pip install --upgrade pip
4049

4150
Then install
4251

4352
python3 -m pip install setuptools
44-
python3 -m pip install raylib==5.5.0.0
53+
python3 -m pip install raylib==5.5.0.2
4554

4655
On most platforms it should install a binary wheel. If yours isn't available then pip will attempt to build from
4756
source, in which case you will need to have Raylib development libs installed, e.g.
@@ -63,7 +72,7 @@ Older MacOS requires building from source but this is usually simple:
6372

6473
brew install pkg-config
6574
brew install raylib
66-
python3 -m pip install raylib==5.5.0.0
75+
python3 -m pip install raylib==5.5.0.2
6776

6877
(I do have binaries for arm64 MacOS 11, 12 and 13 but I have no way of testing they work, so post an issue
6978
if you want to test them.)
@@ -177,7 +186,7 @@ Point your browser to http://localhost:8000
177186
Some features may not work, so you can disable them like this:
178187

179188
```python
180-
if platform.system() != "Emscripten": # audio does not work on current version of emscripten
189+
if platform.system() != "Emscripten": # audio may not work on current version of emscripten
181190
init_audio_device()
182191
```
183192

‎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)