Add some docs.

Author: anntzer

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Antony Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -0,0 +1,46 @@
+A (new) cairo backend for Matplotlib
+====================================
+
+This is a new implementation of a Cairo backend for Matplotlib.  Currently, it
+is designed to be used with the qt-cairo backend proposed in Matplotlib's
+PR #8771.
+
+Installation
+------------
+
+Only Python 3 is supported.  A very recent C++ compiler, with support for C++17
+(e.g., GCC 7.1) is required.
+
+Run::
+
+   $ python -mvenv /path/to/venv
+   $ source /path/to/venv/bin/activate
+   $ git clone https://github.com/matplotlib/matplotlib.git
+   $ git pull origin pull/8771/head:pr/8771
+   $ git checkout pr/8771
+   $ pip install -ve .
+   $ git clone https://github.com/anntzer/mpl_cairo.git
+   $ pip install .
+
+Then, run, e.g.::
+
+   import mpl_cairo; mpl_cairo.install()
+   import matplotlib; matplotlib.use("qt5cairo")
+
+   data = [[0.5, 0.525, 0.55, 0.575, 0.6, 0.625],
+           [0.5, 0.501, 0.502, 0.503, 0.504, 0.505]]
+
+   fig, ax = plt.subplots(figsize=(3.5, 3.5))
+   fig.subplots_adjust(
+       left=0.01, right=0.99, bottom=0.01, top=0.99, hspace=0, wspace=0)
+   ax.set(xlim=(0, 1), ylim=(0, 1))
+   ax.scatter(data[0], data[1], s=25)
+
+and compare the marker position with the default ``qt5agg`` backend.
+
+What about the already existing cairo (gtk3cairo) backend?
+----------------------------------------------------------
+
+It is slow (try running ``examples/mplot3d/wire3d_animation.py``), buggy (try
+calling ``imshow``, especially with an alpha channel), and renders math poorly
+(try ``title(r"\sqrt{2}")``).

setup.py

@@ -1,7 +1,7 @@
+import sys
+
 from setuptools import setup, Extension
 from setuptools.command.build_ext import build_ext
-import sys
-import setuptools
 
 
 __version__ = "0.0"
@@ -56,7 +56,7 @@ def build_extensions(self):
     name="mpl_cairo",
     version=__version__,
     author="Antony Lee",
-    description="A cairo backend for matplotlib.",
+    description="A (new) cairo backend for Matplotlib.",
     long_description="",
     ext_modules=ext_modules,
     install_requires=["pybind11"],

src/_mpl_cairo.cpp

@@ -1,3 +1,9 @@
+// Missing methods:
+//  - draw_markers
+//  - draw_path_collection
+//  - draw_quad_mesh
+//  - draw_gouraud_triangle{,s}
+
 #include <cmath>
 #include <tuple>
 #include <vector>