From: W. Trevor King <wking@tremily.us>
Date: Fri, 19 Oct 2012 13:26:25 +0000 (-0400)
Subject: README: update to mention optional python-kmod dependency.
X-Git-Tag: 0.6~8
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=fe62ce7615fcc4445011ff00bf9f2761fa2b6f6b;p=pycomedi.git

README: update to mention optional python-kmod dependency.
---

diff --git a/README b/README
index 15d5c6d..984d43b 100644
--- 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
@@ -112,6 +119,7 @@ wking@tremily.us
 .. _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://blog.tremily.us/posts/pycomedi/
 .. _GNU General Public License Version 2: