Changeset 174:c3209bd5df14 for README

Timestamp:

09/15/10 22:25:31 (20 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

examples moved to imapclient/examples. Docs updated to match.

Files:

• README (modified) (2 diffs)

README

@@ -68 +68 @@
     python setup.py install
 
-The usual setuptools installation options are available. See
-http://peak.telecommunity.com/DevCenter/EasyInstall for more info.
+The project is packaged using Distribute (mostly compatible with
+setuptools) and all the usual setup.py installation options are
+available. See http://packages.python.org/distribute/ for more info.
 
-See examples/example.py for a simple example of how to use IMAPClient.
+See imapclient/examples/example.py for a sample of how to use
+IMAPClient. If the IMAPClient was installed from PyPI the examples
+subdirectory can be found under whereever the imapclient package is
+installed.
 
 The code is well documented. See the docstrings for more usage
@@ -114 +118 @@
 ----------
 There are comprehensive unit tests for the FETCH response parser and a
-growing number of other parts of the code. These tests use unittest
-and can be run using "python setup.py test" or "python run_tests.py".
+growing number of other parts of the code. These tests use the
+unittest package from the standard library and can be run using
+"python run_tests.py".