Skip to content

Commit

Permalink
Add comments about necessary linux packages in README (#1191)
Browse files Browse the repository at this point in the history
  • Loading branch information
elliottower authored Mar 13, 2024
1 parent 9185ac9 commit 4c90946
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ To install the dependencies for one family, use `pip install 'pettingzoo[atari]'

We support Python 3.8, 3.9, 3.10 and 3.11 on Linux and macOS. We will accept PRs related to Windows, but do not officially support it.

Note: Some Linux distributions may require manual installation of `cmake`, `swig`, or `zlib1g-dev` (e.g., `sudo apt install cmake swig zlib1g-dev`)

## Getting started

For an introduction to PettingZoo, see [Basic Usage](https://pettingzoo.farama.org/content/basic_usage/). To create a new environment, see our [Environment Creation Tutorial](https://pettingzoo.farama.org/tutorials/custom_environment/1-project-structure/) and [Custom Environment Examples](https://pettingzoo.farama.org/content/environment_creation/).
Expand Down

0 comments on commit 4c90946

Please sign in to comment.