From e6ced9a1a817c645551960eeac981c8f33536426 Mon Sep 17 00:00:00 2001
From: Ned Batchelder <ned@nedbatchelder.com>
Date: Mon, 26 Jul 2010 08:15:44 -0400
Subject: Windows kits need setuptools. Fixes #18.

---
 doc/install.rst | 41 ++++++++++++++++++++++++++++++++++-------
 howto.txt       |  1 +
 2 files changed, 35 insertions(+), 7 deletions(-)

diff --git a/doc/install.rst b/doc/install.rst
index fe85d37d..c46e80ed 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -6,27 +6,54 @@ Installation
 
 :history: 20100725T225600, new for 3.4.
 
+.. highlight:: console
 .. _coverage_pypi: http://pypi.python.org/pypi/coverage
 
-Installing coverage.py is simple:
+
+Installing coverage.py is fairly standard:
 
 #.  Download the appropriate kit from the
     `coverage page on the Python Package Index`__.
     
-#.  
+#.  Run ``python setup.py install``.
+
+or, use::
+
+    $ easy_install coverage
+    
+or even::
+
+    $ pip install coverage
 
 .. __: coverage_pypi_
 
 
-You may need to install the python-dev support files, for example with "apt-get
-install python-dev".
+Installing from source
+----------------------
+
+Coverage.py includes a C extension for speed. If you are installing from source,
+you may need to install the python-dev support files, for example with::
+
+    $ sudo apt-get install python-dev
 
 
 Installing on Windows
 ---------------------
 
-For Windows, kits are provided on the `PyPI page`__ for each version of Python and architecture
-combination.  These kits require that setuptools be installed as a pre-requisite,
-but otherwise are self-contained.
+For Windows, kits are provided on the `PyPI page`__ for different versions of
+Python and different CPU architectures. These kits require that `setuptools`_ be
+installed as a pre-requisite, but otherwise are self-contained.  They have the
+C extension pre-compiled so there's no need to worry about compilers.
 
 .. __: coverage_pypi_
+.. _setuptools: http://pypi.python.org/pypi/setuptools
+
+
+Checking the installation
+-------------------------
+
+If all went well, you should be able to open a command prompt, and see
+coverage installed properly::
+
+    $ coverage --version
+    Coverage.py, version 3.4a1.  http://nedbatchelder.com/code/coverage
diff --git a/howto.txt b/howto.txt
index e2d75980..07e231fa 100644
--- a/howto.txt
+++ b/howto.txt
@@ -13,6 +13,7 @@
     - Version, date, and changes in doc/changes.rst
     - Version and date in doc/index.rst
     - Version and copyright date in doc/conf.py
+    - Version --version output in doc/install.py
     - Generate new sample_html to get the latest, incl footer version number:
         cd C:\ned\cog\trunk
         rmdir/s/q htmlcov
-- 
cgit v1.2.1