From 7fed18fa151a35fa602899243a77ee88c5ca00df Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Mon, 21 Aug 2023 16:26:50 +0200
Subject: [PATCH] docs: Update wasmer install docs

Make the necessary step to get wasmer working on Python 3.10 or 3.11
more obvious in all required places.
---
 docs/badge/firmware-development.rst | 16 ++++++++++++++--
 docs/badge/programming.rst          | 17 ++++++++++++-----
 2 files changed, 26 insertions(+), 7 deletions(-)

diff --git a/docs/badge/firmware-development.rst b/docs/badge/firmware-development.rst
index dc64da735e..119c2dc496 100644
--- a/docs/badge/firmware-development.rst
+++ b/docs/badge/firmware-development.rst
@@ -50,13 +50,25 @@ To compile, see `Working on C st3m code`_.
 
 For running the simulator, you'll need Python 3 with pygame and wasmer:
 
-A::
+::
 
 	$ python3 -m venv venv
 	$ . venv/bin/activate
 	$ pip install pygame wasmer wasmer-compiler-cranelift
 
-If using python 3.11, for some reason the wasmer developers haven't published working wheels. We have `unofficial builds here <https://flow3r.garden/tmp/wasmer-py311/>`_.
+.. warning::
+
+    The wasmer python module from PyPI `doesn't work with Python versions 3.10 or 3.11
+    <https://github.com/wasmerio/wasmer-python/issues/539>`_.  You will get
+    ``ImportError: Wasmer is not available on this system`` when trying to run
+    the simulator.
+
+    Instead, install our `rebuilt wasmer wheels <https://flow3r.garden/tmp/wasmer-py311/>`_ using
+
+    ::
+
+        venv/bin/pip install https://flow3r.garden/tmp/wasmer-py311/wasmer_compiler_cranelift-1.2.0-cp311-cp311-manylinux_2_34_x86_64.whl
+        venv/bin/pip install https://flow3r.garden/tmp/wasmer-py311/wasmer-1.2.0-cp311-cp311-manylinux_2_34_x86_64.whl
 
 For Python development, you're also encouraged to use mypy for typechecks. It should be available in your distribution repositories.
 
diff --git a/docs/badge/programming.rst b/docs/badge/programming.rst
index 059893d89d..32467b3a6d 100644
--- a/docs/badge/programming.rst
+++ b/docs/badge/programming.rst
@@ -646,12 +646,19 @@ environment with the required packages:
     $ python3 -m venv venv
     $ venv/bin/pip install pygame wasmer wasmer-compiler-cranelift
 
-.. note::
-    The wasmer python module `doesn't work with Python versions 3.10 or 3.11
-    <https://github.com/wasmerio/wasmer-python/issues/539>`_, use Python 3.9
-    instead. You will get
+.. warning::
+
+    The wasmer python module from PyPI `doesn't work with Python versions 3.10 or 3.11
+    <https://github.com/wasmerio/wasmer-python/issues/539>`_.  You will get
     ``ImportError: Wasmer is not available on this system`` when trying to run
-    the Simulator.
+    the simulator.
+
+    Instead, install our `rebuilt wasmer wheels <https://flow3r.garden/tmp/wasmer-py311/>`_ using
+
+    ::
+
+        venv/bin/pip install https://flow3r.garden/tmp/wasmer-py311/wasmer_compiler_cranelift-1.2.0-cp311-cp311-manylinux_2_34_x86_64.whl
+        venv/bin/pip install https://flow3r.garden/tmp/wasmer-py311/wasmer-1.2.0-cp311-cp311-manylinux_2_34_x86_64.whl
 
 *TODO: set up a pyproject/poetry/... file?*
 
-- 
GitLab