Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit eb6a4b2

Browse filesBrowse files
committed
Update README.
1 parent 95a9cd8 commit eb6a4b2
Copy full SHA for eb6a4b2

File tree

Expand file treeCollapse file tree

1 file changed

+21
-15
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+21
-15
lines changed

‎README.rst

Copy file name to clipboardExpand all lines: README.rst
+21-15Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,40 @@ Noteworthy points include:
2929
Installation
3030
============
3131

32-
mplcairo requires Python 3 (Python 3.6 on Windows) and cairo≥1.11.4 (but
33-
preferably ≥1.15.4) [#]_, and also declares the following dependencies (which
34-
are installed by pip):
32+
mplcairo requires
3533

36-
- Matplotlib≥2.2,
37-
- pybind11≥2.2 [#]_,
38-
- on Linux and OSX only, pycairo≥1.16.0 [#]_.
34+
- Python 3 (3.6 on Windows),
35+
- Matplotlib≥2.2 (declared as ``install_requires``),
36+
- pybind11≥2.2 [#]_ (declared as ``install_requires``),
37+
- on Linux and OSX, pycairo≥1.16.0 [#]_ (declared as conditional
38+
``install_requires``),
39+
- on Windows, cairo≥1.11.4 [#]_ (shipped with the wheel).
3940

40-
Linux and OSX wheels are available on Github releases. Download them manually
41-
and install using pip, as usual.
41+
As usual, install using pip::
4242

43-
.. [#] cairo 1.11.4 added mesh gradient support (used by ``draw_quad_mesh()``).
44-
45-
cairo 1.15.4 added support for PDF metadata and links.
43+
python -mpip install mplcairo
4644

47-
.. [#] pybind11 is technically only a build-time requirement, but doesn't play
45+
.. [#] pybind11 is actually only a build-time requirement, but doesn't play
4846
well with ``setup_requires``.
4947
5048
.. [#] pycairo 1.16.0 added ``get_include()``.
5149
5250
We do not actually rely on pycairo's Python bindings. Rather, specifying a
5351
dependency on pycairo is a convenient way to specify a dependency on cairo
54-
itself, and allows us to load cairo at runtime instead of linking to it
55-
(simplifying the build of self-contained wheels).
52+
(≥1.13.1, for pycairo≥1.14.0) itself, and allows us to load cairo at
53+
runtime instead of linking to it (simplifying the build of self-contained
54+
wheels).
5655
5756
On Windows, this strategy is (AFAIK) not possible, so we explicitly link
5857
against the cairo DLL. Moreover, commonly available Windows builds of
5958
pycairo (Anaconda, conda-forge, Gohlke) do not include FreeType support, and
6059
are thus unusable anyways.
6160
61+
.. [#] cairo 1.11.4 added mesh gradient support (used by ``draw_quad_mesh()``).
62+
63+
(cairo 1.15.4 added support for PDF metadata and links; the presence of this
64+
feature is detected at runtime.)
65+
6266
Building
6367
========
6468

@@ -130,7 +134,9 @@ Windows
130134

131135
The following additional dependencies are required:
132136

133-
- a "recent enough" version of MSVC (19.13.26128 is sufficient).
137+
- a "recent enough" version of MSVC (19.13.26128 is sufficient). (This is the
138+
reason for restricting support to Python 3.6 on Windows: distutils is able to
139+
use MSVC 2017 only since Python 3.6.4.)
134140

135141
- FreeType headers, which can e.g. be installed using conda ::
136142

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.