Skip to content

Commit

Permalink
readme: explain state of system install option
Browse files Browse the repository at this point in the history
  • Loading branch information
mara004 committed Nov 14, 2023
1 parent c5d1885 commit 50d2deb
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,15 @@ pypdfium2 includes helpers to simplify common use cases, while the raw PDFium/ct
* <a id="user-content-install-source-system" class="anchor" href="#install-source-system">With system-provided binary 🔗</a>
```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).
<!-- TODO version.json: reconsider origin - should we add a new field for the packager? -->
* <a id="user-content-install-source-caller" class="anchor" href="#install-source-caller">With caller-built data files 🔗</a> (this is expected to work offline)
* <a id="user-content-install-source-caller" class="anchor" href="#install-source-caller">With caller-provided data files 🔗</a> (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
Expand Down

0 comments on commit 50d2deb

Please sign in to comment.