From 752babdcb621e5e182ec238534a2dafaf300e1d9 Mon Sep 17 00:00:00 2001 From: Jacob Lifshay Date: Fri, 24 Jul 2020 19:59:36 -0700 Subject: [PATCH] add Python build instructions to README.md --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) 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 . +``` -- 2.30.2