Skip to content

Commit 3b0a4b5

Browse files
committed
even better docs
1 parent 605129e commit 3b0a4b5

File tree

2 files changed

+28
-18
lines changed

2 files changed

+28
-18
lines changed

README.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,31 @@ Documentation:
2424
http://zs.readthedocs.org/
2525

2626
Installation:
27-
Because ``zs`` includes a C extension, you'll need a C compiler to
28-
install it. You'll also need either Python 2.7, or else Python 3.3
29-
or greater.
27+
You need either Python **2.7**, or else Python **3.3 or greater**.
3028

31-
Assuming you have a C compiler available, installation in Python 3
32-
should be as simple as::
29+
Because ``zs`` includes a C extension, you'll also need a C compiler
30+
and Python headers. On Ubuntu or Debian, for example, you get these
31+
with::
32+
33+
sudo apt-get install build-essential python-dev
34+
35+
Once you have the ability to build C extensions, then on Python
36+
3 you should be able to just run::
3337

3438
pip install zs
3539

36-
On Python 2.7, ``zs`` also requires the ``backports.lzma`` package,
37-
which in turn requires the liblzma library. On Ubuntu or Debian, for
38-
example, something like this should work::
40+
On Python 2.7, things are slightly more complicated: here, ``zs``
41+
requires the ``backports.lzma`` package, which in turn requires the
42+
liblzma library. On Ubuntu or Debian, for example, something like
43+
this should work::
3944

4045
sudo apt-get install liblzma-dev
4146
pip install backports.lzma
4247
pip install zs
4348

4449
``zs`` also requires the following packages: ``six``, ``docopt``,
4550
``requests``. However, these are all pure-Python packages which pip
46-
will install for you automatically.
51+
will install for you automatically when you run ``pip install zs``.
4752

4853
Downloads:
4954
http://pypi.python.org/pypi/zs/

doc/logistics.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,31 @@ Documentation:
55
http://zs.readthedocs.org/
66

77
Installation:
8-
Because ``zs`` includes a C extension, you'll need a C compiler to
9-
install it. You'll also need either Python 2.7, or else Python 3.3
10-
or greater.
8+
You need either Python **2.7**, or else Python **3.3 or greater**.
119

12-
Assuming you have a C compiler available, installation in Python 3
13-
should be as simple as::
10+
Because ``zs`` includes a C extension, you'll also need a C compiler
11+
and Python headers. On Ubuntu or Debian, for example, you get these
12+
with::
13+
14+
sudo apt-get install build-essential python-dev
15+
16+
Once you have the ability to build C extensions, then on Python
17+
3 you should be able to just run::
1418

1519
pip install zs
1620

17-
On Python 2.7, ``zs`` also requires the ``backports.lzma`` package,
18-
which in turn requires the liblzma library. On Ubuntu or Debian, for
19-
example, something like this should work::
21+
On Python 2.7, things are slightly more complicated: here, ``zs``
22+
requires the ``backports.lzma`` package, which in turn requires the
23+
liblzma library. On Ubuntu or Debian, for example, something like
24+
this should work::
2025

2126
sudo apt-get install liblzma-dev
2227
pip install backports.lzma
2328
pip install zs
2429

2530
``zs`` also requires the following packages: ``six``, ``docopt``,
2631
``requests``. However, these are all pure-Python packages which pip
27-
will install for you automatically.
32+
will install for you automatically when you run ``pip install zs``.
2833

2934
Downloads:
3035
http://pypi.python.org/pypi/zs/

0 commit comments

Comments
 (0)