Skip to content

Commit 1f4edbc

Browse files
committed
simplify README
1 parent ed8daf8 commit 1f4edbc

File tree

2 files changed

+12
-19
lines changed

2 files changed

+12
-19
lines changed

README.md

+11-18
Original file line numberDiff line numberDiff line change
@@ -14,29 +14,24 @@ This is **version 1.13.15 of PyMuPDF (formerly python-fitz)**, a Python binding
1414

1515
MuPDF can access files in PDF, XPS, OpenXPS, CBZ, EPUB and FB2 (e-books) formats, and it is known for its top performance and high rendering quality.
1616

17-
With PyMuPDF you therefore can also access files with extensions ``*.pdf``, ``*.xps``, ``*.oxps``, ``*.cbz``, ``*.fb2`` or ``*.epub`` from your Python scripts.
17+
With PyMuPDF you therefore can access files with extensions ``*.pdf``, ``*.xps``, ``*.oxps``, ``*.cbz``, ``*.fb2`` or ``*.epub`` from your Python scripts.
1818

1919
See the [Wiki](https://github.com/rk700/PyMuPDF/wiki) for more information, [news](https://github.com/rk700/PyMuPDF/wiki/Change-and-News-Log), release notes and usage recipies.
2020

2121
# Installation
2222

23-
For all **Windows** and - thanks to our user @jbarlow83 - the major **Mac OSX** and **Linux** versions we offer wheel-based installation options. Look [here](https://github.com/rk700/PyMuPDF/releases/latest) to find the version for your OS. These files can also be found in the [download section of PyPI](https://pypi.org/project/PyMuPDF/#files).
23+
For all **Windows** and (thanks to our user **@jbarlow83**) for the major **Mac OSX** and **Linux** versions we offer [wheels](https://github.com/rk700/PyMuPDF/releases/latest). They can also be found in the [download section of PyPI](https://pypi.org/project/PyMuPDF/#files), where we are present since August 2015 - [![](http://pepy.tech/badge/pymupdf)](http://pepy.tech/project/pymupdf) since then.
2424

2525
If - for whatever reason - you need to generate PyMuPDF yourself, you must download and generate MuPDF before you can generate PyMuPDF. This process depends very much on your system. For most platforms, the MuPDF source contains prepared procedures to achieve this.
2626

27-
Be sure to download the official MuPDF release from [here](https://mupdf.com/downloads). MuPDF also has a GitHub repo, but this contains their current **development source**, which more often than not is incompatible with this PyMuPDF.
27+
Be sure to download the official MuPDF source release from [here](https://mupdf.com/downloads). The [GitHub repo](https://github.com/ArtifexSoftware/mupdf) of MuPDF contains their current **development source**, which more often than not is incompatible with this PyMuPDF version.
2828

29-
Once this is done, adjust directories in ``setup.py`` and the rest should be as easy as running ``python setup.py install``.
29+
Once this is done, adjust directories in ``setup.py`` and the rest should be as easy as running the usual ``python setup.py install``.
3030

31-
The following sections contain some platform-specific comments, but please do refer to our documentation for more.
32-
33-
## Arch Linux
34-
AUR: https://aur.archlinux.org/packages/python2-pymupdf/ currently only provides PyMuPDF version 1.9.2 for Python 2.
31+
The following sections contain some platform-specific comments.
3532

3633
## Ubuntu
37-
The required MuPDF version in the official Ubuntu repositories is often not timely available, so you do need to build it from source. Make sure to add ``-fPIC`` to CFLAGS when compiling.
38-
39-
When MuPDF is ready, edit ``setup.py`` in PyMuPDF and comment out the line of ``library_dirs=[]`` to specify the directory which contains ``libmupdf.a`` and other 3rd party libraries. Remove ``crypto`` from ``libraries`` in ``setup.py`` if it complains. One of our users (thanks to @gileadslostson) has documented his MuPDF installation experience from sources in this [Wiki page](https://github.com/rk700/PyMuPDF/wiki/Experience-from-an-Ubuntu-installation).
34+
One of our users (thanks to **@gileadslostson**) has documented his MuPDF installation experience from sources in this [Wiki page](https://github.com/rk700/PyMuPDF/wiki/Experience-from-an-Ubuntu-installation).
4035

4136
## OSX
4237
First, install the MuPDF headers and libraries, which are provided by mupdf-tools: ``brew install mupdf-tools``.
@@ -47,28 +42,26 @@ Finally, please double check ``setup.py`` before building. Update ``include_dirs
4742

4843
## MS Windows
4944

50-
If you don't use ``pip`` or [PyPI](https://pypi.org/project/PyMuPDF/), you can still download [pre-generated binaries](https://github.com/JorjMcKie/PyMuPDF-Optional-Material) that are suitable for your Python / Windows combination. This, too, avoids any other download or compilation hassle. Again, make sure to consult our documentation.
45+
In addition to wheels, this platform offers [pre-generated binaries](https://github.com/JorjMcKie/PyMuPDF-Optional-Material) in a ZIP format, which can be used without PIP.
5146

52-
If you do want to make your own binary however, have a look at this [Wiki page](https://github.com/rk700/PyMuPDF/wiki/Windows-Binaries-Generation). It explains how to use Visual Studio for generating MuPDF in quite some detail. Also do not hesitate to contact us if you need help.
47+
If you are looking to make your own binary, consult this [Wiki page](https://github.com/rk700/PyMuPDF/wiki/Windows-Binaries-Generation). It explains how to use Visual Studio for generating MuPDF in quite some detail.
5348

5449
# Usage and Documentation
5550
Have a look at the basic [demos](https://github.com/rk700/PyMuPDF/tree/master/demo), the [examples](https://github.com/rk700/PyMuPDF/tree/master/examples) (which contain complete, working programs), and the **recipies** section of our [Wiki](https://github.com/rk700/PyMuPDF/wiki) sidebar, which contains more than a dozen of guides in How-To-style.
5651

5752
Our documentation, written using Sphinx, is available in various formats from the following sources.
5853

5954
* You can view it online at [Read the Docs](https://pymupdf.readthedocs.io/). For **best quality downloads** use the following links.
60-
* [HTML](https://github.com/rk700/PyMuPDF/tree/master/doc/html.zip)
55+
* zipped [HTML](https://github.com/rk700/PyMuPDF/tree/master/doc/html.zip)
6156
* [Windows CHM](https://github.com/JorjMcKie/PyMuPDF-optional-material/tree/master/doc/PyMuPDF.chm)
6257
* [PDF](https://github.com/rk700/PyMuPDF/tree/master/doc/pymupdf.pdf)
6358

64-
Earlier Versions
65-
================
59+
# Earlier Versions
6660
Earlier versions are available in the [releases](https://github.com/rk700/PyMuPDF/releases) directory.
6761

6862
# License
69-
PyMuPDF is distributed under GNU GPL V3. Because you will also be using MuPDF, its license GNU AFFERO GPL V3 applies as well. Copies of both licenses are included in this repository.
63+
PyMuPDF is distributed under GNU GPL V3. Because you will also be using MuPDF, its license GNU AFFERO GPL V3 applies as well. Copies of both are included in this repository.
7064

7165
# Contact
72-
You can also find us on the Python Package Index [PyPI](https://pypi.org/project/PyMuPDF/). Currently, totalling [![](http://pepy.tech/badge/pymupdf)](http://pepy.tech/project/pymupdf) from that site since August 2015.
7366

7467
Please submit questions, comments or issues [here](https://github.com/rk700/PyMuPDF/issues), or directly contact the authors via their e-mail addresses.

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# 'crypto', #openssl is required by mupdf on archlinux
1919
], # the libraries to link with
2020
)
21-
elif sys.platform.startswith('darwin'):
21+
elif sys.platform.startswith(('darwin', 'freebsd'))
2222
module = Extension('fitz._fitz', # name of the module
2323
['fitz/fitz_wrap.c'], # C source file
2424
# this are directories containing mupdf's and zlib's header files

0 commit comments

Comments
 (0)