Skip to content

Commit 6773ea3

Browse files
committed
readme: Change 3.5 to 3.5+; update build from source instructions
1 parent 33cb17e commit 6773ea3

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

README.rst

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ echo protocol. Read more about uvloop
3737
Installation
3838
------------
3939

40-
uvloop requires Python 3.5 and is available on PyPI.
40+
uvloop requires Python 3.5 or greater and is available on PyPI.
4141
Use pip to install it::
4242

4343
$ pip install uvloop
@@ -53,23 +53,40 @@ loop policy:
5353
5454
import asyncio
5555
import uvloop
56+
5657
asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
5758
5859
59-
Development of uvloop
60-
---------------------
60+
Building From Source
61+
--------------------
62+
63+
To build uvloop, you'll need Python 3.5 or greater:
64+
65+
1. Clone the repository:
66+
67+
.. code::
68+
69+
$ git clone --recursive [email protected]:MagicStack/uvloop.git
70+
$ cd uvloop
71+
72+
2. Create a virtual environment and activate it, for example:
73+
74+
.. code::
75+
76+
$ python3.7 -m venv uvloop-dev
77+
$ source uvloop-dev/bin/activate
78+
79+
3. Install development dependencies:
6180

62-
To build uvloop, you'll need Cython and Python 3.5. The best way
63-
is to create a virtual env, so that you'll have ``cython`` and
64-
``python`` commands pointing to the correct tools.
81+
.. code::
6582
66-
1. ``git clone --recursive [email protected]:MagicStack/uvloop.git``
83+
$ pip install -r requirements.dev.txt
6784
68-
2. ``cd uvloop``
85+
4. Build and run tests:
6986

70-
3. ``make``
87+
.. code::
7188
72-
4. ``make test``
89+
$ make && make test
7390
7491
7592
License

0 commit comments

Comments
 (0)