Skip to content

Commit 573875f

Browse files
committed
Add Python 3 note to readme
1 parent b341085 commit 573875f

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,3 +156,18 @@ Project Layout
156156
changes to the master metadata need to be incorporated.
157157
* The `tools/` directory holds the tools that are used to process upstream
158158
changes to the master metadata.
159+
160+
Python 3.x Support
161+
------------------
162+
163+
There are currently two ways to get a Python 3 version of the library.
164+
165+
* Check out the main branch, and run `make python3` from the `tools/python` directory. This will produce a new
166+
top-level `python3/` directory containing the Python 3 version of the library, as produced by
167+
[2to3](http://docs.python.org/2/library/2to3.html).
168+
* Check out the (somewhat experimental) `python3` branch, which holds a unified version of the library that runs
169+
under both Python 2.x (x >= 5) and Python 3.x.
170+
171+
At some point the `python3` branch will probably become the main branch, but at the moment it sometimes lags behind the
172+
main branch. Please let me know if you're using the `python3` branch in anger, so that I can know to keep it more
173+
up-to-date (and possibly accelerate the plans to make it the mainline version).

0 commit comments

Comments
 (0)