Skip to content

Commit 8b77182

Browse files
authored
Update README.md
1 parent c9f21c0 commit 8b77182

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,14 @@ The platform tag for Mac OSX is `macosx_10_6_intel`.
3030

3131
The platform tag for Linux is `manylinux1_x86_64`, which makes these wheels usable on Debian, Ubuntu and most other variations.
3232

33-
On other operating systems you need to generate PyMuPDF yourself. Before you can do this, you must download and generate MuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures for achieving this.
33+
On other operating systems you need to generate PyMuPDF yourself. And of course you can choose to do so for a wheel-supported platform, too. Before you can do this, you must download and generate MuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures for achieving this.
3434

35-
Be sure to download the official MuPDF source release from [here](https://mupdf.com/downloads). Do **not use** MuPDF's [GitHub repo](https://github.com/ArtifexSoftware/mupdf). It contains their current **development source**, which is **not compatible** with this PyMuPDF version most of the time.
35+
* Be sure to download the official MuPDF source release from [here](https://mupdf.com/downloads). Do **not use** MuPDF's [GitHub repo](https://github.com/ArtifexSoftware/mupdf). It contains their current **development source**, which is **not compatible** with this PyMuPDF version most of the time.
36+
37+
* The repo's `fitz` folder contains a few files whose names start with an underscore. These files contain configuration data and hotfixes and each must be copy-renamed to its correct target location of the downloaded MuPDF source **before you generate MuPDF**. Currently, these files are:
38+
- fitz configuration file `_mupdf_config.h` copy-replace to `mupdf/include/fitz/config.h`.
39+
- fitz error module `_error.c`, copy-replace to `mupdf/source/fitz/error.c`.
40+
- PDF device module `_pdf-device.c` copy-replace `mupdf/source/pdf/pdf-device.c`.
3641

3742
Once this is done, adjust directories in ``setup.py`` and run ``python setup.py install``.
3843

0 commit comments

Comments
 (0)