doc: Add documentation about using wheel

This commit is contained in:
Leni Aniva 2024-12-10 16:40:07 -08:00
parent b5a711202c
commit 1aacbfa42e
Signed by: aniva
GPG Key ID: 4D9B1C8D10EA4C50
1 changed files with 7 additions and 1 deletions

View File

@ -4,7 +4,13 @@ Install `poetry`. Then, run
```sh ```sh
poetry build poetry build
``` ```
This builds a wheel of Pantograph which can then be installed.
This builds a wheel of Pantograph in `dist` which can then be installed. For
example, a downstream project could have this line in its `pyproject.toml`
```toml
pantograph = { file = "path/to/wheel/dist/pantograph-0.2.19-cp312-cp312-manylinux_2_40_x86_64.whl" }
```
To run the examples and experiments, setup a poetry shell: To run the examples and experiments, setup a poetry shell:
```sh ```sh