README

The Conservative Python 3 Porting Guide
=======================================

A guide for people for whom Python 3 is a necessary nuisance, written for
large, conservative codebases that need to start supporting Python 3.


Building
--------

To build the documentation locally, use a Python 3 virtualenv,
install sphinx:

    $ python -m pip install sphinx

... and run it:

    $ make html


Testing
-------

We have a few automatic tests. To run them, install dependencies:

    $ python -m pip install -r test-requirements.txt

... and run:

    $ python -m pytest -v


Licence
-------

This guide is released under the [CC BY-SA 4.0] licence.

Additionally, all code in this repository (including code samples in the text,
tests, build scripts) is dedicated to the public domain under the
[CC0 1.0] dedication.

[CC BY-SA 4.0]: https://creativecommons.org/licenses/by-sa/4.0/
[CC0 1.0]: https://creativecommons.org/publicdomain/zero/1.0/

See the files `LICENCE.CC-BY-SA` and `LICENCE.CC0`, respectively, for the
license text.