From c0c0d9575e225081560b6f476382224b44f1ad51 Mon Sep 17 00:00:00 2001 From: Lola Marrero <110120745+lola831@users.noreply.github.com> Date: Tue, 12 Nov 2024 16:28:49 -0800 Subject: [PATCH] Update install_notes.rst -Revised pyglet installation instructions for Apple silicon based on review feedback. -Suggested running pip install pyglet==1.5.26 in the virtual environment instead of editing pyproject.toml. -Removed the pip freeze check. --- docs/install_notes.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/install_notes.rst b/docs/install_notes.rst index ccd347fa2..ad3a1aede 100644 --- a/docs/install_notes.rst +++ b/docs/install_notes.rst @@ -96,12 +96,10 @@ If on an Apple-silicon machine you get an error related to pip being unable to i Scenic generates only one scene on Apple silicon +++++++++++++++++++++++++++++++++++++++++++++++++++ -If on an Apple-silicon machine you get an error where your run a ``.scenic`` file and it only generates a single scene, you may need to downgrade the version of ``pyglet`` as follows: +If you're using an Apple-silicon machine and you encounter an issue where running a ``.scenic`` file generates only a single scene, try the following steps to adjust the ``pyglet`` version: -1. Follow the MacOS instructions on :ref:`quickstart` for the repository installation. -2. Inside the root of the Scenic repo, update the ``pyglet`` version from ``"pyglet ~= 1.5"`` to ``"pyglet == 1.5.26"``. -3. Activate the virutal environment if you haven't done so already and run: ``python -m pip install -e .`` -4. Confirm that you are using the updated version of ``pyglet`` by running: ``pip freeze``. +1. Complete the usual Scenic installation steps, including activating a virtual environment. +2. Run: ``pip install pyglet==1.5.26`` For more updates on the related issue, please refer to the `GitHub open issue `_.