Skip to content

Commit 7797284

Browse files
Add key step to catalog update instructions (#800)
1 parent 0eee1b6 commit 7797284

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

doc/developer.catalog.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Updating the Games Catalog
44
This page covers the process for contributing to and updating Gambit's :ref:`Games Catalog <pygambit-catalog>`.
55
To do so, you will need to have the `gambit` GitHub repo cloned and be able to submit pull request via GitHub;
66
you may wish to first review the :ref:`contributor guidelines <contributing>`.
7+
You'll also need to have a developer install of `pygambit` available in your Python environment, see :ref:`build-python`.
78

89
You can add games to the catalog saved in a valid representation :ref:`format <file-formats>`.
910
Currently supported representations are:
@@ -24,16 +25,14 @@ Add new games
2425

2526
3. **Update the catalog:**
2627

27-
Use the ``update.py`` script to update Gambit's documentation & build files.
28+
Reinstall the package to pick up the new game file(s) in the ``pygambit.catalog`` module.
29+
Then use the ``update.py`` script to update Gambit's documentation & build files.
2830

2931
.. code-block:: bash
3032
33+
pip install .
3134
python build_support/catalog/update.py --build
3235
33-
.. note::
34-
35-
Run this script in a Python environment where ``pygambit`` itself is also :ref:`installed <build-python>`.
36-
3736
.. warning::
3837

3938
Running the script with the ``--build`` flag updates `Makefile.am`. If you moved games that were previously in `contrib/games` you'll need to also manually remove those files from `EXTRA_DIST`.

0 commit comments

Comments
 (0)