update docs

Author: electronstudio

README.md

@@ -51,7 +51,7 @@ There is now a separate dynamic version of this binding:
 
 ## Beta testing
 
-You can install an alpha or beta version by specifying the version number like this:
+You can install an alpha or beta version by specifying the exact version number like this:
 
     python3 -m pip install raylib==4.0a6
 

docs/BUILDING.html

@@ -36,7 +36,7 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 3.7</a></li>
+<li class="toctree-l1"><a class="reference internal" href="README.html">Python Bindings for Raylib 4.0-dev</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#installation">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="README.html#how-to-use">How to use</a></li>
@@ -90,7 +90,7 @@
 <h1>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h1>
 <div class="section" id="have-pip-build-from-source">
 <h2>Have Pip build from source<a class="headerlink" href="#have-pip-build-from-source" title="Permalink to this headline"></a></h2>
-<p>Useful if the binaries don’t work on your system.</p>
+<p>Useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.</p>
 <p>Make sure Raylib is installed and then:</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">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>
@@ -130,20 +130,17 @@ <h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title
 <span class="n">cd</span> <span class="o">..</span>\<span class="o">..</span>
 </pre></div>
 </div>
-<p>To update the dynamic libs, download the official release,
-e.g. <a class="reference external" href="https://github.com/raysan5/raylib/releases/download/3.7.0/raylib-3.7.0_win64_msvc16.zip">https://github.com/raysan5/raylib/releases/download/3.7.0/raylib-3.7.0_win64_msvc16.zip</a>
-and extract <code class="docutils literal notranslate"><span class="pre">raylib.dll</span></code> into <code class="docutils literal notranslate"><span class="pre">dynamic/raylib</span></code>.</p>
 <p>To build a binary wheel distribution:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rmdir</span> <span class="o">/</span><span class="n">Q</span> <span class="o">/</span><span class="n">S</span> <span class="n">build</span>
 <span class="n">pip3</span> <span class="n">install</span> <span class="n">cffi</span>
 <span class="n">pip3</span> <span class="n">install</span> <span class="n">wheel</span>
 <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>
-<p>Alternatively, if you don’t want the static binaries and just want to
-use DLLs with raylib.dynamic:</p>
-<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>
-</pre></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</span><span class="o">.</span><span class="mi">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>
@@ -154,13 +151,17 @@ <h3>Windows manual build<a class="headerlink" href="#windows-manual-build" title
 </div>
 <div class="section" id="linux-manual-build">
 <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Permalink to this headline"></a></h3>
-<p>These instructions have been tested on Ubuntu 20.10 and 16.04.</p>
 <p>Clone this repo including submodules so you get correct version of
 Raylib.</p>
 <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>
 </pre></div>
 </div>
 <p>Build and install Raylib from the raylib-c directory.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>You can instead use a different version of Raylib you installed from elsewhere, and it should still
+work!</p>
+</div>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">cmake</span> <span class="n">libasound2</span><span class="o">-</span><span class="n">dev</span> <span class="n">mesa</span><span class="o">-</span><span class="n">common</span><span class="o">-</span><span class="n">dev</span> <span class="n">libx11</span><span class="o">-</span><span class="n">dev</span> <span class="n">libxrandr</span><span class="o">-</span><span class="n">dev</span> <span class="n">libxi</span><span class="o">-</span><span class="n">dev</span> <span class="n">xorg</span><span class="o">-</span><span class="n">dev</span> <span class="n">libgl1</span><span class="o">-</span><span class="n">mesa</span><span class="o">-</span><span class="n">dev</span> <span class="n">libglu1</span><span class="o">-</span><span class="n">mesa</span><span class="o">-</span><span class="n">dev</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="n">mkdir</span> <span class="n">build</span>
@@ -183,18 +184,6 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Pe
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">../..</span>
 </pre></div>
 </div>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>Optional: Make a patched version of raylib header. (<strong>Not necessary</strong> if
-you’ve already got raylib_modifed.h from repo and haven’t changed
-anything.)</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">raylib</span>
-<span class="n">cp</span> <span class="n">raylib</span><span class="o">.</span><span class="n">h</span> <span class="n">raylib_modified</span><span class="o">.</span><span class="n">h</span>
-<span class="n">patch</span>  <span class="o">-</span><span class="n">p0</span> <span class="o">&lt;</span><span class="n">raylib_modified</span><span class="o">.</span><span class="n">h</span><span class="o">.</span><span class="n">patch</span>
-<span class="n">cd</span> <span class="o">..</span>
-</pre></div>
-</div>
-</div>
 <p>Build</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">cffi</span>
 <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">_raylib_cffi</span><span class="o">.*</span>
@@ -203,7 +192,7 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Pe
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>(Optional) To update the Linux dynamic libs (names will be different on other platfroms):</p>
+<p>(Optional) To update the Linux dynamic libs (names will be different on other platforms):</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rm</span> <span class="n">dynamic</span><span class="o">/</span><span class="n">raylib</span><span class="o">/*.</span><span class="n">so</span><span class="o">*</span>
 <span class="n">cp</span> <span class="o">-</span><span class="n">P</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">libraylib</span><span class="o">.</span><span class="n">so</span><span class="o">*</span> <span class="n">dynamic</span><span class="o">/</span><span class="n">raylib</span><span class="o">/</span>
 </pre></div>
@@ -228,7 +217,7 @@ <h3>Linux manual build<a class="headerlink" href="#linux-manual-build" title="Pe
 <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="id1">
+<div class="admonition-todo admonition" id="id2">
 <p class="admonition-title">Todo</p>
 <p>Separate the instructions for preparing the dynamic module
 from the instructions for building the static module!</p>
@@ -243,9 +232,12 @@ <h3>Macos manual build<a class="headerlink" href="#macos-manual-build" title="Pe
 </pre></div>
 </div>
 <p>Build and install Raylib from the raylib-c directory.</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="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>
+<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">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">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">cp</span> <span class="n">libraylib</span><span class="o">.</span><span class="n">a</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">libraylib</span><span class="o">.</span><span class="n">a</span>
+<span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
 <span class="n">cd</span> <span class="o">../..</span>
 </pre></div>
 </div>

docs/README.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Bindings for Raylib 3.7 &mdash; Raylib Python  documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>Python Bindings for Raylib 4.0-dev &mdash; Raylib Python  documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -37,10 +37,11 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 3.7</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Python Bindings for Raylib 4.0-dev</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#quickstart">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#installation">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#dynamic-binding-version">Dynamic binding version</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#beta-testing">Beta testing</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="#how-to-use">How to use</a><ul>
@@ -77,7 +78,7 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Python Bindings for Raylib 3.7</li>
+      <li>Python Bindings for Raylib 4.0-dev</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
       </li>
@@ -87,11 +88,17 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <div class="tex2jax_ignore mathjax_ignore section" id="python-bindings-for-raylib-3-7">
-<h1>Python Bindings for Raylib 3.7<a class="headerlink" href="#python-bindings-for-raylib-3-7" title="Permalink to this headline"></a></h1>
-<p>New CFFI API static bindings.  Automatically generated to be as close as possible to
-original Raylib.  Faster, fewer bugs and easier to maintain than ctypes.  Commercial-friendly license.
-Docstrings and auto-completion.</p>
+  <div class="tex2jax_ignore mathjax_ignore section" id="python-bindings-for-raylib-4-0-dev">
+<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>
+<p>New CFFI API static bindings.</p>
+<ul class="simple">
+<li><p>Automatically generated to be as close as possible to
+original Raylib.</p></li>
+<li><p>Faster, fewer bugs and easier to maintain than ctypes.</p></li>
+<li><p>Commercial-friendly license.</p></li>
+<li><p>Docstrings and auto-completion.</p></li>
+<li><p><strong>Now includes extra libraries: raygui, rlgl and physac</strong></p></li>
+</ul>
 <p><a class="reference external" href="http://electronstudio.github.io/raylib-python-cffi">Full documentation</a></p>
 </div>
 <div class="tex2jax_ignore mathjax_ignore section" id="quickstart">
@@ -110,7 +117,7 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
 </div>
 <div class="tex2jax_ignore mathjax_ignore section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
-<p>First make sure you have latest pip installed:</p>
+<p>First make sure you have the latest pip installed:</p>
 <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip install --upgrade pip
 </pre></div>
 </div>
@@ -130,6 +137,13 @@ <h2>Dynamic binding version<a class="headerlink" href="#dynamic-binding-version"
 </div>
 <p><a class="reference external" href="https://electronstudio.github.io/raylib-python-cffi/dynamic.html">Read this before using raylib_dynamic</a></p>
 </div>
+<div class="section" id="beta-testing">
+<h2>Beta testing<a class="headerlink" href="#beta-testing" title="Permalink to this headline"></a></h2>
+<p>You can install an alpha or beta version by specifying the version number like this:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>python3 -m pip install raylib==4.0a6
+</pre></div>
+</div>
+</div>
 </div>
 <div class="tex2jax_ignore mathjax_ignore section" id="how-to-use">
 <h1>How to use<a class="headerlink" href="#how-to-use" title="Permalink to this headline"></a></h1>

docs/_sources/BUILDING.rst.txt

@@ -4,7 +4,7 @@ Building from source
 Have Pip build from source
 --------------------------
 
-Useful if the binaries don’t work on your system.
+Useful if the binaries don’t work on your system, or you want to use a newer version of Raylib.
 
 Make sure Raylib is installed and then:
 
@@ -56,9 +56,7 @@ Build and install Raylib from the raylib-c directory.
    copy raylib\Release\raylib.lib ..\..
    cd ..\..
 
-To update the dynamic libs, download the official release,
-e.g. https://github.com/raysan5/raylib/releases/download/3.7.0/raylib-3.7.0_win64_msvc16.zip
-and extract ``raylib.dll`` into ``dynamic/raylib``.
+
 
 To build a binary wheel distribution:
 
@@ -69,12 +67,10 @@ To build a binary wheel distribution:
    pip3 install wheel
    python setup.py bdist_wheel
 
-Alternatively, if you don’t want the static binaries and just want to
-use DLLs with raylib.dynamic:
-
-::
+.. 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.
 
-   python3 setup_dynamic.py bdist_wheel
 
 Then install it:
 
@@ -88,8 +84,6 @@ here.)
 Linux manual build
 ~~~~~~~~~~~~~~~~~~~~~~
 
-These instructions have been tested on Ubuntu 20.10 and 16.04.
-
 Clone this repo including submodules so you get correct version of
 Raylib.
 
@@ -99,6 +93,10 @@ Raylib.
 
 Build and install Raylib from the raylib-c directory.
 
+.. note::
+   You can instead use a different version of Raylib you installed from elsewhere, and it should still
+   work!
+
 ::
 
    sudo apt install cmake libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev
@@ -123,17 +121,6 @@ Build and install Raylib from the raylib-c directory.
    cd ../..
 
 
-..  note:: Optional: Make a patched version of raylib header. (**Not necessary** if
-    you’ve already got raylib_modifed.h from repo and haven’t changed
-    anything.)
-
-    ::
-
-       cd raylib
-       cp raylib.h raylib_modified.h
-       patch  -p0 <raylib_modified.h.patch
-       cd ..
-
 Build
 
 ::
@@ -142,7 +129,7 @@ Build
    rm -rf build raylib/_raylib_cffi.*
    python3 raylib/build.py
 
-..  note:: (Optional) To update the Linux dynamic libs (names will be different on other platfroms):
+..  note:: (Optional) To update the Linux dynamic libs (names will be different on other platforms):
 
     ::
 
@@ -196,10 +183,13 @@ Build and install Raylib from the raylib-c directory.
 
 ::
 
-   cd raylib-python-cffi/raylib-c/src
-   make
-   sudo cp libraylib.a  /usr/local/lib/libraylib.a
-   cd ../..
+    cd raylib-python-cffi/raylib-c/
+    mkdir build
+    cd build
+    cmake -DWITH_PIC=on -DCMAKE_BUILD_TYPE=Release ..
+    make
+    sudo make install
+    cd ../..
 
 
 Build and install module.