From cfd2363083e1f0697b40bf59529db64dcf4e485d Mon Sep 17 00:00:00 2001 From: Flavio Martins Date: Sat, 12 Sep 2026 18:03:10 +0100 Subject: [PATCH] Update README.md to include instructions for native builds and installation from Git --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 506076b..2048477 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,26 @@ Or to install it directly into your current environment: uv pip install pyfastpfor ``` -### Building from source +### Native builds + +Native builds automatically use `-march=native` on Unix-like platforms when +the compiler supports it. Set `PYFASTPFOR_PORTABLE=1` for a portable build. + +#### Install from Git + +To build and install the native extension directly from the latest Git source: + +``` +pip install "pyfastpfor @ git+https://github.com/fast-pack/PyFastPFor.git#subdirectory=python_bindings" +``` + +With uv: + +``` +uv pip install "pyfastpfor @ git+https://github.com/fast-pack/PyFastPFor.git#subdirectory=python_bindings" +``` + +#### Build a local checkout From the repository root, run: