setup.py: add explicit classifier for GPLv2+

[pycomedi.git] / README

diff --git a/README b/README
index fca4c53adc546076493f769c3223644d3ec119a3..984d43b009455382e674b4dc6349bddb5c55875e 100644 (file)
--- a/README
+++ b/README
@@ -34,17 +34,24 @@ Dependencies
 If you're installing by hand or packaging pycomedi for another
 distribution, you'll need the following dependencies:
 
-=======  ===================  ================  ==========================
-Package  Purpose              Debian_           Gentoo_
-=======  ===================  ================  ==========================
-NumPy_   ?                    python-numpy      dev-python/numpy
-SciPy_   testing              python-scipy      sci-libs/scipy
-Comedi_  Comedilib interface  python-comedilib  sci-libs/comedilib [#clb]_
-nose_    testing              python-nose       dev-python/nose
-Cython_  Comedilib interface  cython            dev-python/cython
-=======  ===================  ================  ==========================
-
-.. [#clb] In the `wtk overlay`_.
+============  ===================  ================  ==============================
+Package       Purpose              Debian_           Gentoo_
+============  ===================  ================  ==============================
+NumPy_        ?                    python-numpy      dev-python/numpy
+SciPy_        testing              python-scipy      sci-libs/scipy
+Comedi_       Comedilib interface  python-comedilib  sci-libs/comedilib [#wtk]_
+nose_         testing              python-nose       dev-python/nose
+Cython_       Comedilib interface  cython            dev-python/cython
+python-kmod_  Optional ext. info.                    dev-python/python-kmod [#wtk]_
+============  ===================  ================  ==============================
+
+.. [#wtk] In the `wtk overlay`_.
+
+If python-kmod is installed, you will get additional module
+information from the ``info.py`` demo program.  If it is not
+installed, everything will still work, but ``info.py`` will only be
+able to get the module version, not the kernel version, staging-ness,
+parameters, etc.
 
 
 Installing by hand
@@ -52,7 +59,7 @@ Installing by hand
 
 Pycomedi is available as a Git_ repository::
 
-    $ git clone http://www.physics.drexel.edu/~wking/code/git/pycomedi.git
+    $ git clone git://tremily.us/pycomedi.git
 
 
 See the homepage_ for details.  To install the checkout, run the
@@ -70,10 +77,19 @@ See the examples in the `doc` directory.
 Testing
 =======
 
-Integration tests with::
+Run integration tests with::
 
     $ nosetests --with-doctest --doctest-extension=txt doc
 
+The analog integration tests read from analog input channels 0 through
+3, and write to analog output channels 0 and 1, so you'll need a board
+with that many channels.  You should also make sure that the analog
+output channels aren't plugged into anything sensetive, since the
+tests sweep their output around over a reasonable chunk of the channel
+range.  Some of the internal unit tests also write, so it's safest to
+just disconnect all digital lines and analog outputs before running
+the tests.
+
 Run both integration tests and internal unit tests with::
 
     $ ./test.sh
@@ -83,20 +99,19 @@ Licence
 =======
 
 This project is distributed under the `GNU General Public License
-Version 3`_ or greater.
+Version 2`_ or greater.
 
 
 Author
 ======
 
 W. Trevor King
-wking@drexel.edu
+wking@tremily.us
 
 
 .. _Comedi: http://www.comedi.org/
 .. _layman: http://layman.sourceforge.net/
-.. _wtk overlay:
-     http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay
+.. _wtk overlay: http://blog.tremily.us/posts/Gentoo_overlay/
 .. _science overlay: http://overlays.gentoo.org/proj/science/wiki/en
 .. _Debian: http://www.debian.org/
 .. _Gentoo: http://www.gentoo.org/
@@ -104,7 +119,8 @@ wking@drexel.edu
 .. _SciPy: http://www.scipy.org/
 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/
 .. _Cython: http://www.cython.org/
+.. _python-kmod: https://github.com/agrover/python-kmod/
 .. _Git: http://git-scm.com/
-.. _homepage:
-     http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pycomedi/
-.. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt
+.. _homepage: http://blog.tremily.us/posts/pycomedi/
+.. _GNU General Public License Version 2:
+     http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt