Updates across the board

This commit is contained in:
Chris Proctor
2026-06-22 16:41:31 -04:00
parent 5ca97dc5d0
commit 73624d1a0c
33 changed files with 3104 additions and 643 deletions

View File

@@ -31,17 +31,22 @@ with `retro-games <https://retro-games.readthedocs.io/en/latest/>`__.
The retro-games framework must also be installed; see its documentation
for instructions.
If you are working through a Making With Code lab, ``retro-gamer`` is
already installed in your project environment — skip ahead to
:ref:`installation`.
**Add to a project** using ``uv`` or ``pip``:
.. code-block:: console
% uv add retro-gamer
% pip install retro-gamer
To install from source (for development or to use the latest changes):
**Install as a global tool** (available everywhere, no project needed):
.. code-block:: console
% git clone https://github.com/cproctor/retro-gamer
% cd retro-gamer
% pip install -e .
% uv tool install retro-gamer
Verify the installation by checking the command-line tool:
@@ -65,5 +70,8 @@ Verify the installation by checking the command-line tool:
introduction
background
walkthrough
troubleshooting
reference
integration
api
contributing