diff --git a/README.md b/README.md index 77babde09..ffc577cbc 100644 --- a/README.md +++ b/README.md @@ -85,13 +85,15 @@ pypdfium2 includes helpers to simplify common use cases, while the raw PDFium/ct * With system-provided binary 🔗 ```bash # Substitute $PDFIUM_VER with the system pdfium's build version. + # For ABI safety reasons, you'll want to make sure `$PDFIUM_VER` is correct and the bindings are rebuilt whenever system pdfium is updated. PDFIUM_PLATFORM="system:$PDFIUM_VER" python -m pip install -v . ``` Link against external pdfium instead of bundling it. - For ABI safety reasons, you'll want to make sure `$PDFIUM_VER` is correct and the bindings are rebuilt whenever system pdfium is updated. + Note, this is basically a high-level convenience entry point to internal bindings generation, and intended for end users. Therefore it is less flexible, supporting only the "simple case". + For more sohpisticated use cases that need passing custom parameters to ctypesgen (e.g. runtime libdirs / headers / feature flags), consider [caller-provided data files](#install-source-caller). - * With caller-built data files 🔗 (this is expected to work offline) + * With caller-provided data files 🔗 (this is expected to work offline) ```bash # Call ctypesgen (see --help or packaging_base.py::run_ctypesgen() for further options) # Reminder: you'll want to use the pypdfium2-team fork of ctypesgen