Commit 9360ed21 authored by Jason Madden's avatar Jason Madden

Clarify intro document about versions supported [skip ci]

parent a45b281c
...@@ -26,7 +26,7 @@ Get gevent ...@@ -26,7 +26,7 @@ Get gevent
Install Python 2.6, 2.7, 3.3 or 3.4 along with the greenlet_ extension Install Python 2.6, 2.7, 3.3 or 3.4 along with the greenlet_ extension
(Python 3.5 has preliminary support). Or install PyPy 4.0.1 or above (Python 3.5 has preliminary support). Or install PyPy 4.0.1 or above
(but not PyPy3) (*note*: PyPy is not supported in Windows). On all (but not PyPy3) (*Note*: PyPy is not supported in Windows). On all
platforms, installing setuptools is recommended (this is done platforms, installing setuptools is recommended (this is done
automatically if working in a virtual environment). automatically if working in a virtual environment).
...@@ -45,7 +45,8 @@ To install the latest development version:: ...@@ -45,7 +45,8 @@ To install the latest development version::
pip install setuptools 'cython>=0.23.4' git+git://github.com/gevent/gevent.git#egg=gevent pip install setuptools 'cython>=0.23.4' git+git://github.com/gevent/gevent.git#egg=gevent
.. note:: You must have Cython installed to build a checkout. .. note:: You must have Cython, a C compiler, and the Python
development headers installed to build a checkout.
Running Tests Running Tests
------------- -------------
......
...@@ -22,22 +22,25 @@ Features include: ...@@ -22,22 +22,25 @@ Features include:
Installation and Requirements Installation and Requirements
============================= =============================
gevent runs on Python 2 and Python 3. Versions 2.6 and 2.7 of Python 2 `gevent 1.1`_ runs on Python 2 and Python 3. Versions 2.6 and 2.7 of
are supported, and versions 3.3, 3.4, and 3.5 of Python 3 are Python 2 are supported, and versions 3.3, 3.4, and 3.5 of Python 3 are
supported. gevent requires the greenlet__ library. supported. (Users of older versions of Python need to install gevent
1.0.x.) gevent requires the greenlet__ library.
gevent also runs on PyPy 2.5.0 and above, although 2.6.1 or above is gevent 1.1 also runs on PyPy 2.6.1 and above, although 4.0 or above is
strongly recommended. On PyPy, there are no external dependencies. strongly recommended. On PyPy, there are no external dependencies.
gevent and greenlet can both be installed with `pip`_, e.g., ``pip gevent and greenlet can both be installed with `pip`_, e.g., ``pip
install gevent``. On Windows, both gevent and greenlet are distributed install gevent``. On Windows and OS X, both gevent and greenlet are
as binary `wheels`_, so no C compiler is required (so long as pip is distributed as binary `wheels`_, so no C compiler is required (so long
at least version 1.4). On Linux and Mac OS X, a C compiler (Xcode on as pip is at least version 1.4). On Linux or for Mac OS X variants
OS X) and the Python development package are required. without pre-built wheels or if wheel installation is disabled, a C compiler
(Xcode on OS X) and the Python development package are required.
__ http://pypi.python.org/pypi/greenlet __ http://pypi.python.org/pypi/greenlet
.. _`pip`: https://pip.pypa.io/en/stable/installing/ .. _`pip`: https://pip.pypa.io/en/stable/installing/
.. _`wheels`: http://pythonwheels.com .. _`wheels`: http://pythonwheels.com
.. _`gevent 1.1`: whatsnew_1_1.html
Example Example
======= =======
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment