Apply suggestions from code review

Co-authored-by: Casper da Costa-Luis <casper.dcl@physics.org>

.gitignore

@@ -2,8 +2,8 @@
 /cpp/build/
 /python/petsird/
 __pycache__/
-build/
-petsird.egg-info/
+/python/build/
+/python/petsird.egg*
 
 # Common editor backups
 /.vscode/

python/README.md

@@ -2,11 +2,9 @@
 
 This directory contains some Python example code to read/write PETSIRD data.
 
-## Pre-installation
+## Install
 
-You will need the Python files generated by yardl. You have a few options.
-
-### Use PyPI
+Some python code is generated by `yardl` and included in the PyPI distribution.
 
 ```sh
 python3 -m venv ~/petsirdenv
@@ -19,12 +17,12 @@ pip install petsird
 (This option needs the `yardl` binary, either download it, or use our devcontainer or GitHub CodeSpace.)
 
 You need to `yardl generate` in the `model` directory first. This will create the Python package files in a `petsird`
-subfolder. Optionally install those into your venv
+subfolder.
+
 ```sh
-python3 -m venv ~/petsirdenv
-source ~/petsirdenv/bin/activate
-cd python
-pip install .
+cd ../model
+yardl generate
+pip install --editable ../python
 ```
 
 ## Usage

python/README.pypi.md

@@ -1,9 +1,10 @@
 # PETSIRD Python SDK
 
 The [Emission Tomography Standardization Initiative (ETSI)](https://etsinitiative.org/)
-is working towards establishing a standard for PET Raw Data, called PETSIRD ("PET ETSI Raw Data").
+is working towards establishing a standard for PET Raw Data, called PETSIRD ("Positron Emission Tomography Standardization Initiative Raw Data").
 
-This python package contains the python SDK to read/write PETSIRD data.
+Read & write PETSIRD data in Python.
 
-Examples for how to use this package are available at
-https://github.com/ETSInitiative/PETSIRD/tree/main/python
+## Examples
+
+See [ETSInitiative/PETSIRD:python](https://github.com/ETSInitiative/PETSIRD/tree/main/python).