From: Jacob Lifshay <programmerjake@gmail.com>
Date: Sat, 25 Jul 2020 02:59:36 +0000 (-0700)
Subject: add Python build instructions to README.md
X-Git-Tag: v0.2.0~38
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=752babdcb621e5e182ec238534a2dafaf300e1d9;p=power-instruction-analyzer.git

add Python build instructions to README.md
---

diff --git a/README.md b/README.md
index 145a683..8acb5ce 100644
--- 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 .
+```