Skip to content

Commit 94103af

Browse files
committed
Update README
1 parent 57802c6 commit 94103af

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
Release date: Sept 1, 2017
66

77
# Authors
8-
* Ruikai Liu
9-
* Jorj X. McKie
8+
* [Ruikai Liu]([email protected])
9+
* [Jorj X. McKie]([email protected])
1010

1111
# Introduction
1212

@@ -20,19 +20,21 @@ See the [Wiki](https://github.com/rk700/PyMuPDF/wiki) for more information, [new
2020

2121

2222
# Installation
23-
If you had not previously installed MuPDF, you must first do this (however, see the **MS Windows** section further down). This process highly depends on your system. For most platforms, the MuPDF source contains prepared procedures on how to achieve this. If you decide to generate MuPDF from sources, be sure to download the official release from https://mupdf.com/downloads/. MuPDF also has a GitHub repo, but it contains the current **development source**, which probably is not compatible with this PyMuPDF.
23+
If you had not previously installed MuPDF, you must first do this (however, see the **MS Windows** section further down). This process very much depends on your system. For most platforms, the MuPDF source contains prepared procedures on how to achieve this.
24+
25+
If you decide to generate MuPDF from sources (definitely the safest and cleanest way for all platforms except MS Windows), be sure to download the official release from [here](https://mupdf.com/downloads). Although MuPDF also has a GitHub repo, this contains their current **development source**, which usually is incompatible with this PyMuPDF.
2426

2527
Once MuPDF is in place, installing PyMuPDF comes down to running the usual ``python setup.py install``.
2628

27-
Also refer to our documentation for details.
29+
Refer to our documentation for additional comments.
2830

2931
## Arch Linux
30-
AUR: https://aur.archlinux.org/packages/python2-pymupdf/
32+
AUR: https://aur.archlinux.org/packages/python2-pymupdf/ currently only provides PyMuPDF version 1.9.2 for Python 2.
3133

3234
## Ubuntu
33-
The required MuPDF version in the official Ubuntu repositories is often not timely available, so you need to build it from source. Make sure to add ``-fPIC`` to CFLAGS when compiling.
35+
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.
3436

35-
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. For a MuPDF installation experience from sources visit this [Wiki page](https://github.com/rk700/PyMuPDF/wiki/Experience-from-an-Ubuntu-installation).
37+
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).
3638

3739
## OSX
3840
First, install the MuPDF headers and libraries, which are provided by mupdf-tools: ``brew install mupdf-tools``.
@@ -42,21 +44,25 @@ Then you might need to ``export ARCHFLAGS='-arch x86_64'`` since ``libmupdf.a``
4244
Finally, please double check ``setup.py`` before building. Update ``include_dirs`` and ``library_dirs`` if necessary.
4345

4446
## MS Windows
45-
The lucky Windows user can just issue `pip install PyMuPDF [--upgrade]`. This requires **nothing else** - no MuPDF, no Visual Studio, ... whatsoever.
47+
The lucky Windows user can now just issue `pip install PyMuPDF [--upgrade]` and is done in no more time than a 3 MB download takes. This requires **nothing else** - no MuPDF, no Visual Studio, ... whatsoever.
4648

47-
Without using ``pip`` and [PyPI](https://pypi.org/project/PyMuPDF/), you can download pre-generated binaries or Python wheels from [here](https://github.com/JorjMcKie/PyMuPDF-Optional-Material) that are suitable for your Python / Windows combination, and thereby avoid any compilation hassle. Again, make sure to consult our documentation.
49+
If you don't use ``pip`` or [PyPI](https://pypi.org/project/PyMuPDF/), you can still download pre-generated binaries or Python wheels from [here](https://github.com/JorjMcKie/PyMuPDF-Optional-Material) that are suitable for your Python / Windows combination. This, too, avoids any other downloads or compilation hassle. Again, make sure to consult our documentation.
4850

4951
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.
5052

5153
# Usage and Documentation
52-
Please 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).
54+
Please 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.
5355

5456
You have a number of options to access the **documentation**:
5557

56-
* You can view it online at [Read the Docs](https://pymupdf.readthedocs.io/en/latest/), which you can download as [HTML ZIP file](https://github.com/rk700/PyMuPDF/tree/master/doc/html.zip).
58+
* You can view it online at [Read the Docs](https://pymupdf.readthedocs.io/en/latest/), which you can also download as [HTML ZIP file](https://github.com/rk700/PyMuPDF/tree/master/doc/html.zip).
5759
* You can download a [Windows CHM](https://github.com/JorjMcKie/PyMuPDF-optional-material/tree/master/doc/PyMuPDF.chm).
5860
* You can download a [PDF](https://github.com/rk700/PyMuPDF/tree/master/doc/pymupdf.pdf).
5961

62+
> The new **PyPI Warehouse** no longer supports the maintenance of documentation hosted at https://pythonhosted.org. Their plans also include to retire this facility altogether as the PyPI Warehouse matures. They are encouraging the use of https://readthedocs.org instead.
63+
64+
> We have decided to immediately follow their recommendation. Therefore, you will now find PyMuPDF's current online documentation on **Read the Docs** as indicated above. Because we haven't been able to update our documentation on **pythonhosted.org** since June of 2017, we also decided to delete it there to avoid confusion.
65+
6066
Earlier Versions
6167
================
6268
* [PyMuPDF Version 1.10.0](https://github.com/rk700/PyMuPDF/tree/1.10.0)
@@ -77,8 +83,10 @@ Earlier Versions
7783
PyMuPDF is distributed under GNU GPL V3. The implied use of MuPDF also implies its license GNU AFFERO GPL V3. A copy of both licenses are included in this repository.
7884

7985
# Contact
80-
You can also find PyMuPDF on the Python Package Index [PyPI](https://pypi.org/project/PyMuPDF/)
86+
You can also find us on the Python Package Index [PyPI](https://pypi.org/project/PyMuPDF/).
87+
88+
> Please note, that the project description on PyPI may be less current than the one you are looking at. This is because information on PyPI cannot be changed once stored there. Previously, this has been true for download files only, but since **PyPI Warehouse**, it obviously applies to everything else that defines a project (verbal description, classifiers, platforms, etc.).
8189
82-
We invite you to join our efforts by contributing to the the wiki pages.
90+
We invite you to join our efforts by contributing to the [Wiki](https://github.com/rk700/PyMuPDF/wiki) pages.
8391

84-
Please submit comments or any issues either to this site or by sending an e-mail to the authors [Ruikai Liu](lrk700@gmail.com) and [Jorj X. McKie]([email protected]).
92+
Please submit comments or issues [here](https://github.com/rk700/PyMuPDF/issues), or directly contact the authors.

0 commit comments

Comments
 (0)