Update the readme

This commit is contained in:
Marek Wolan
2024-01-25 14:59:00 +00:00
parent a3a7d11ff7
commit 5a9eaeb185

View File

@@ -33,7 +33,7 @@ Currently, the PrimAITE wheel can only be installed from GitHub. This may change
#### Windows (PowerShell)
**Prerequisites:**
* Manual install of Python >= 3.8 < 3.11
* Manual install of Python >= 3.9 < 3.12
**Install:**
@@ -56,7 +56,7 @@ primaite session
#### Unix
**Prerequisites:**
* Manual install of Python >= 3.8 < 3.11
* Manual install of Python >= 3.9 < 3.12
``` bash
sudo add-apt-repository ppa:deadsnakes/ppa
@@ -82,6 +82,7 @@ primaite session
```
### Developer Install from Source
To make your own changes to PrimAITE, perform the install from source (developer install)
@@ -138,3 +139,7 @@ make html
cd docs
.\make.bat html
```
## Example notebooks
Check out the example notebooks to learn more about how PrimAITE works and how you can use it to train agents. They are automatically copied to your primaite installation directory when you run `primaite setup`.