update docs with links

Author: electronstudio

.gitignore

@@ -101,3 +101,4 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+.aider*

README.md

@@ -5,8 +5,6 @@
 
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/raylib)
 
-Chatroom: [Discord](https://discord.gg/fKDwt85aX6)
-
 HELP WANTED: [writing examples](https://github.com/electronstudio/raylib-python-cffi/issues/155)
 
 Features:
@@ -19,9 +17,6 @@ original Raylib.
 * Docstrings and auto-completion.
 * Type checking with Mypy
 
-
-[Full documentation](http://electronstudio.github.io/raylib-python-cffi)
-
 # Quickstart
 
 `pip3 install raylib==5.5.0.2 --break-system-packages`
@@ -36,6 +31,19 @@ while not window_should_close():
 close_window()
 ```
 
+# Links
+
+* [Tutorial video](https://www.youtube.com/watch?v=UoAsDlUwjy0&lc=UgxCR-tvnQJITZr2IvN4AaABAg)
+* [Full documentation](http://electronstudio.github.io/raylib-python-cffi)
+* [Imgui integration](https://github.com/Scr44gr/raylib-imgui)
+* [Examples](https://github.com/electronstudio/raylib-python-cffi/tree/master/examples)
+* [Blep's examples](https://github.com/blep/pyray_examples)
+* [Raylib Python Discord](https://discord.gg/fKDwt85aX6)
+* [Raylib General Discord](https://discord.com/invite/raylib)
+* [Python video player](https://github.com/anrayliu/pyvidplayer2)
+* [A Vector2 class](https://github.com/electronstudio/raylib-python-cffi/blob/master/examples/extra/vector2_extended.py)
+* [Raylib C FAQ](https://github.com/raysan5/raylib/wiki/Frequently-Asked-Questions/)
+
 # Installation
 
 If you are on a modern Linux you will probably want to create a venv:

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f2032a6434b52f7c68551d0ad70d555b
+config: 8201ba0ecd19ace25eb070033b3dde79
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/BUILDING.html

@@ -47,6 +47,7 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 5.5</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#quickstart">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#links">Links</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#backends">Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
@@ -63,6 +64,7 @@
 <li class="toctree-l1"><a class="reference internal" href="dynamic.html">Dynamic Bindings</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Building from source</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#have-pip-build-from-source">Have Pip build from source</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#environment-variables-new-in-5-5-0-3">Environment variables (new in 5.5.0.3)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#or-build-from-source-manually">Or, Build from source manually</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#windows-manual-build">Windows manual build</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#linux-manual-build">Linux manual build</a></li>
@@ -102,23 +104,44 @@
 <h1>Building from source<a class="headerlink" href="#building-from-source" title="Link to this heading"></a></h1>
 <section id="have-pip-build-from-source">
 <h2>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Link to this heading"></a></h2>
-<p>This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.</p>
+<p>This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib, or compile
+Raylib with a different version of OpenGL than the default.  (e.g. on old hardware use cmake option <code class="docutils literal notranslate"><span class="pre">-DOPENGL_VERSION=1.1</span></code>)</p>
 <p>First make sure Raylib is installed.  On Linux/Mac it must include the pkg-config files.  Best way to ensure this
 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>
 <p>Requirements for build: cmake, pkg-config.</p>
-<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">5.0</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wget</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">raysan5</span><span class="o">/</span><span class="n">raylib</span><span class="o">/</span><span class="n">archive</span><span class="o">/</span><span class="n">refs</span><span class="o">/</span><span class="n">tags</span><span class="o">/</span><span class="mf">5.5</span><span class="o">.</span><span class="n">zip</span>
+<span class="n">unzip</span> <span class="mf">5.5</span><span class="o">.</span><span class="n">zip</span>
+<span class="n">cd</span> <span class="n">raylib</span><span class="o">-</span><span class="mf">5.5</span>
 <span class="n">mkdir</span> <span class="n">build</span>
 <span class="n">cd</span> <span class="n">build</span>
 <span class="n">cmake</span>  <span class="o">-</span><span class="n">DCUSTOMIZE_BUILD</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DSUPPORT_FILEFORMAT_JPG</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DSUPPORT_FILEFORMAT_FLAC</span><span class="o">=</span><span class="n">ON</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>
 <span class="n">make</span>
 <span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
+<span class="n">export</span> <span class="n">PKG_CONFIG_PATH</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">pkgconfig</span>
 </pre></div>
 </div>
 <p>Then ask Pip to build from source:</p>
 <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">cache</span><span class="o">-</span><span class="nb">dir</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>
 </pre></div>
 </div>
 </section>
+<section id="environment-variables-new-in-5-5-0-3">
+<h2>Environment variables (new in 5.5.0.3)<a class="headerlink" href="#environment-variables-new-in-5-5-0-3" title="Link to this heading"></a></h2>
+<p>If plg-config doesn’t work you can manually set these environment variables:</p>
+<p><code class="docutils literal notranslate"><span class="pre">RAYLIB_PLATFORM</span></code>: Any one of: <code class="docutils literal notranslate"><span class="pre">Desktop</span></code>, <code class="docutils literal notranslate"><span class="pre">SDL</span></code>, <code class="docutils literal notranslate"><span class="pre">DRM</span></code>, <code class="docutils literal notranslate"><span class="pre">PLATFORM_COMMA</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">RAYLIB_LINK_ARGS</span></code>: Arguments to pass to the linker rather than getting them from pkg-config.
+e.g.: <code class="docutils literal notranslate"><span class="pre">&quot;-L/usr/local/lib</span> <span class="pre">-lraylib&quot;</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">RAYLIB_INCLUDE_PATH</span></code>: Directory to find raylib.h rather than getting from pkg-config.
+e.g.: <code class="docutils literal notranslate"><span class="pre">/usr/local/include</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">RAYGUI_INCLUDE_PATH</span></code>: Directory to find raygui.h
+e.g.: <code class="docutils literal notranslate"><span class="pre">/usr/local/include</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">GLFW_INCLUDE_PATH</span></code>: Directory to find glfw3.h
+e.g.: <code class="docutils literal notranslate"><span class="pre">/usr/local/include/GLFW</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">PHYSAC_INCLUDE_PATH</span></code>: Directory to find physac.h
+e.g.: <code class="docutils literal notranslate"><span class="pre">/usr/local/include</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">LIBFFI_INCLUDE_PATH</span></code>:
+e.g.: <code class="docutils literal notranslate"><span class="pre">/usr/local/include</span></code></p>
+</section>
 <section id="or-build-from-source-manually">
 <h2>Or, Build from source manually<a class="headerlink" href="#or-build-from-source-manually" title="Link to this heading"></a></h2>
 <p>Useful if the Pip build doesn’t work and you want to debug it, or you want to contribute to the
@@ -160,11 +183,6 @@ <h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title
 <span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">bdist_wheel</span>
 </pre></div>
 </div>
-<div class="admonition-todo admonition" id="id1">
-<p class="admonition-title">Todo</p>
-<p>There’s a hardcoded path (to the raylib header files) in <cite>raylib/build.py</cite> you will probably need to edit.
-Would be useful if some Windows user could figure out how to auto detect this.</p>
-</div>
 <p>Then install it:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip3</span> <span class="n">install</span> <span class="n">dist</span>\<span class="n">raylib</span><span class="o">-</span><span class="mf">3.7.0</span><span class="o">-</span><span class="n">cp37</span><span class="o">-</span><span class="n">cp37m</span><span class="o">-</span><span class="n">win_amd64</span><span class="o">.</span><span class="n">whl</span>
 </pre></div>
@@ -191,6 +209,7 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Li
 <span class="n">cd</span> <span class="n">build</span>
 <span class="n">cmake</span> <span class="o">-</span><span class="n">DCUSTOMIZE_BUILD</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DSUPPORT_FILEFORMAT_JPG</span><span class="o">=</span><span class="n">ON</span> <span class="o">-</span><span class="n">DSUPPORT_FILEFORMAT_FLAC</span><span class="o">=</span><span class="n">ON</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>
 <span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
+<span class="n">export</span> <span class="n">PKG_CONFIG_PATH</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">pkgconfig</span>
 </pre></div>
 </div>
 <div class="admonition note">
@@ -240,7 +259,7 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Li
 <code class="docutils literal notranslate"><span class="pre">--plat-name</span> <span class="pre">manylinux2014_x86_64</span></code> so on linux please run
 <code class="docutils literal notranslate"><span class="pre">./raylib/build_multi_linux.sh</span></code> )</p>
 </div>
-<div class="admonition-todo admonition" id="id2">
+<div class="admonition-todo admonition" id="id1">
 <p class="admonition-title">Todo</p>
 <p>Separate the instructions for preparing the dynamic module
 from the instructions for building the static module!</p>

docs/README.html

@@ -52,6 +52,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="#quickstart">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="#links">Links</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#installation">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#windows">Windows</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#macos">MacOS</a></li>
@@ -124,7 +125,6 @@ <h2>Backends: Desktop, SDL, DRM, Web<a class="headerlink" href="#backends-deskto
 <section id="platforms-windows-mac-linux-raspberry-pi-web">
 <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>
 <p><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/raylib" /></p>
-<p>Chatroom: <a class="reference external" href="https://discord.gg/fKDwt85aX6">Discord</a></p>
 <p>HELP WANTED: <a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/issues/155">writing examples</a></p>
 <p>Features:</p>
 <ul class="simple">
@@ -136,7 +136,6 @@ <h2>Platforms: Windows, Mac, Linux, Raspberry Pi, Web<a class="headerlink" href=
 <li><p>Docstrings and auto-completion.</p></li>
 <li><p>Type checking with Mypy</p></li>
 </ul>
-<p><a class="reference external" href="http://electronstudio.github.io/raylib-python-cffi">Full documentation</a></p>
 </section>
 </section>
 <section id="quickstart">
@@ -153,6 +152,21 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this headi
 </pre></div>
 </div>
 </section>
+<section id="links">
+<h1>Links<a class="headerlink" href="#links" title="Link to this heading"></a></h1>
+<ul class="simple">
+<li><p><a class="reference external" href="https://www.youtube.com/watch?v=UoAsDlUwjy0&amp;amp;lc=UgxCR-tvnQJITZr2IvN4AaABAg">Tutorial video</a></p></li>
+<li><p><a class="reference external" href="http://electronstudio.github.io/raylib-python-cffi">Full documentation</a></p></li>
+<li><p><a class="reference external" href="https://github.com/Scr44gr/raylib-imgui">Imgui integration</a></p></li>
+<li><p><a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/tree/master/examples">Examples</a></p></li>
+<li><p><a class="reference external" href="https://github.com/blep/pyray_examples">Blep’s examples</a></p></li>
+<li><p><a class="reference external" href="https://discord.gg/fKDwt85aX6">Raylib Python Discord</a></p></li>
+<li><p><a class="reference external" href="https://discord.com/invite/raylib">Raylib General Discord</a></p></li>
+<li><p><a class="reference external" href="https://github.com/anrayliu/pyvidplayer2">Python video player</a></p></li>
+<li><p><a class="reference external" href="https://github.com/electronstudio/raylib-python-cffi/blob/master/examples/extra/vector2_extended.py">A Vector2 class</a></p></li>
+<li><p><a class="reference external" href="https://github.com/raysan5/raylib/wiki/Frequently-Asked-Questions/">Raylib C FAQ</a></p></li>
+</ul>
+</section>
 <section id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
 <p>If you are on a modern Linux you will probably want to create a venv:</p>

docs/RPI.html

@@ -46,6 +46,7 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 5.5</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#quickstart">Quickstart</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html#links">Links</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#backends">Backends</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>

docs/_sources/BUILDING.rst.txt

@@ -4,7 +4,8 @@ Building from source
 Have Pip build from source
 --------------------------
 
-This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
+This is useful if the binaries don’t work on your system, or you want to use a newer version of Raylib, or compile
+Raylib with a different version of OpenGL than the default.  (e.g. on old hardware use cmake option ``-DOPENGL_VERSION=1.1``)
 
 First make sure Raylib is installed.  On Linux/Mac it must include the pkg-config files.  Best way to ensure this
 is to compile and install Raylib using CMake: https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux#build-raylib-using-cmake
@@ -13,21 +14,47 @@ Requirements for build: cmake, pkg-config.
 
 ::
 
-      cd raylib-5.0
-      mkdir build
-      cd build
-      cmake  -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
-      make
-      sudo make install
-
-
+        wget https://github.com/raysan5/raylib/archive/refs/tags/5.5.zip
+        unzip 5.5.zip
+        cd raylib-5.5
+        mkdir build
+        cd build
+        cmake  -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
+        make
+        sudo make install
+        export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
 
 Then ask Pip to build from source:
 
 ::
 
    pip3 install --no-cache-dir --no-binary raylib --upgrade --force-reinstall raylib
 
+Environment variables (new in 5.5.0.3)
+--------------------------------------
+
+If plg-config doesn't work you can manually set these environment variables:
+
+``RAYLIB_PLATFORM``: Any one of: ``Desktop``, ``SDL``, ``DRM``, ``PLATFORM_COMMA``
+
+``RAYLIB_LINK_ARGS``: Arguments to pass to the linker rather than getting them from pkg-config.
+e.g.: ``"-L/usr/local/lib -lraylib"``
+
+``RAYLIB_INCLUDE_PATH``: Directory to find raylib.h rather than getting from pkg-config.
+e.g.: ``/usr/local/include``
+
+``RAYGUI_INCLUDE_PATH``: Directory to find raygui.h
+e.g.: ``/usr/local/include``
+
+``GLFW_INCLUDE_PATH``: Directory to find glfw3.h
+e.g.: ``/usr/local/include/GLFW``
+
+``PHYSAC_INCLUDE_PATH``: Directory to find physac.h
+e.g.: ``/usr/local/include``
+
+``LIBFFI_INCLUDE_PATH``:
+e.g.: ``/usr/local/include``
+
 Or, Build from source manually
 ------------------------------
 
@@ -83,11 +110,6 @@ To build a binary wheel distribution:
    pip3 install wheel
    python setup.py bdist_wheel
 
-.. TODO::
-   There's a hardcoded path (to the raylib header files) in `raylib/build.py` you will probably need to edit.
-   Would be useful if some Windows user could figure out how to auto detect this.
-
-
 Then install it:
 
 ::
@@ -121,6 +143,7 @@ Build and install Raylib from the raylib-c directory.
    cd build
    cmake -DCUSTOMIZE_BUILD=ON -DSUPPORT_FILEFORMAT_JPG=ON -DSUPPORT_FILEFORMAT_FLAC=ON -DWITH_PIC=ON -DCMAKE_BUILD_TYPE=Release ..
    sudo make install
+   export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
 
 .. note:: Optional: Build the Raylib shared libs, if you plan to use
    ``raylib_dynamic`` binding.