add Python build instructions to README.md

diff --git a/README.md b/README.md
index 145a683344602f7099a25c243808640a3a691d6c..8acb5ce7f19ec0d0f4d565ddccf1de6321c7fc9b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-Program to analyze the behavior of Power ISA instructions
\ No newline at end of file
+Program to analyze the behavior of Power ISA instructions
+
+## Python Build Instructions
+
+requires a recent version of Rust stable
+
+```bash
+cargo install maturin
+git clone https://salsa.debian.org/Kazan-team/power-instruction-analyzer.git
+cd power-instruction-analyzer
+maturin build --cargo-extra-args=--features=python-extension
+python3 -m pip install --user target/wheels/*.whl
+```
+
+alternatively, if in a python3 virtualenv:
+
+```bash
+git clone https://salsa.debian.org/Kazan-team/power-instruction-analyzer.git
+cd power-instruction-analyzer
+maturin develop --cargo-extra-args=--features=python-extension
+```
+or
+```bash
+git clone https://salsa.debian.org/Kazan-team/power-instruction-analyzer.git
+cd power-instruction-analyzer
+pip install .
+```