README: Add installation and testing advice

[pycalendar.git] / README

diff --git a/README b/README
index e0e54cbae94dc0d80640aa65a0c0c8f661d62526..053a1f9d44a6c4805a3287b50b4eccd07ea16ea7 100644 (file)
--- a/README
+++ b/README
@@ -13,9 +13,29 @@ weight.
 
 __ `elmcity code`_
 
+Installation
+============
+
+Pycalendar is packaged with distutils_, so you can install it in all
+the usual ways.  Any of the following should work::
+
+  $ python setup.py install
+  $ pip install pycalendar
+
+There are no dependencies outside Python's standard library.
+
+Testing
+=======
+
+Test with nose_::
+
+  $ nosetests --with-doctest --doctest-tests pycalendar
+
 
 .. _Calagator: http://calagator.org/
+.. _distutils: http://docs.python.org/3/distutils/
 .. _elmcity: http://elmcity.cloudapp.net/
 .. _elmcity code: https://github.com/judell/elmcity
 .. _feedparser: https://pypi.python.org/pypi/feedparser/
 .. _Google Calendar: https://support.google.com/calendar/
+.. _nose: https://nose.readthedocs.org/en/latest/