surface: Ensure min_position < max_position in _get_min_max_positions

[pypiezo.git] / README

diff --git a/README b/README
index 8370012271530e93245969f3aeb396fe75be2ee5..e0a125df65ae01fb395f387319a21ffeaa37ba93 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,8 @@
-Pypiezo: Python modules to control piezoelectric actuators.
+Pypiezo
+=======
 
-Mostly a set of convenient wrappers around pycomedi calls for keeping
+Pypiezo is a Python module to control piezoelectric actuators.  It is
+mostly a set of convenient wrappers around pycomedi_ calls for keeping
 track of the relevant calibration constants.  To get a feel for an
 "official" set of calibration constants, you can take a peek at
 `veeco_header`, which is the beginning of a saved Veeco NanoScope
@@ -17,29 +19,33 @@ Packages
 Gentoo
 ~~~~~~
 
-I've packaged FFT-tools for Gentoo.  You need layman_ and my `wtk
+I've packaged pypiezo for Gentoo.  You need layman_ and my `wtk
 overlay`_.  Install with::
 
     # emerge -av app-portage/layman
     # layman --add wtk
-    # emerge -av sci-libs/pycomedi
+    # emerge -av sci-libs/pypiezo
 
 
 Dependencies
 ------------
 
-If you're installing by hand or packaging pycomedi for another
+If you're installing by hand or packaging pypiezo for another
 distribution, you'll need the following dependencies:
 
-===========  =================  =====================
-Package      Debian_            Gentoo_
-===========  =================  =====================
-Numpy_       python-numpy       dev-python/numpy
-Scipy_       python-scipy       sci-libs/scipy
-Matplotlib_  python-matplotlib  dev-python/matplotlib
-Nose_        python-nose        dev-python/nose
-Pycomedi_                       dev-python/pycomedi
-===========  =================  =====================
+==========================  =================  =============================================
+Package                     Debian_            Gentoo_
+==========================  =================  =============================================
+Numpy_                      python-numpy       dev-python/numpy
+Scipy_                      python-scipy       sci-libs/scipy
+Matplotlib_                 python-matplotlib  dev-python/matplotlib
+H5config_                                      dev-python/h5config [#wtk]_
+Curses-check-for-keypress_                     dev-python/curses-check-for-keypress [#wtk]_
+Nose_                       python-nose        dev-python/nose
+Pycomedi_                                      dev-python/pycomedi [#wtk]_
+==========================  =================  =============================================
+
+.. [#wtk] In the `wtk overlay`_.
 
 
 Installing by hand
@@ -47,7 +53,7 @@ Installing by hand
 
 Pypiezo is available as a Git_ repository::
 
-    $ git clone http://www.physics.drexel.edu/~wking/code/git/pypiezo.git
+    $ git clone git://tremily.us/pypiezo.git
 
 See the homepage_ for details.  To install the checkout, run the
 standard::
@@ -80,20 +86,21 @@ Author
 ======
 
 W. Trevor King
-wking@drexel.edu
-Copyright 2007-2011
+wking@tremily.us
 
 
 .. _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/
 .. _Debian: http://www.debian.org/
 .. _Gentoo: http://www.gentoo.org/
 .. _NumPy: http://numpy.scipy.org/
 .. _SciPy: http://www.scipy.org/
 .. _Matplotlib: http://matplotlib.sourceforge.net/
+.. _H5config: http://blog.tremily.us/posts/h5config/
+.. _Curses-check-for-keypress:
+    http://blog.tremily.us/posts/curses-check-for-keypress/
 .. _Nose: http://somethingaboutorange.com/mrl/projects/nose/
+.. _Pycomedi: http://blog.tremily.us/posts/pycomedi/
 .. _Git: http://git-scm.com/
-.. _homepage:
-     http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/pypiezo/
+.. _homepage: http://blog.tremily.us/posts/pypiezo/
 .. _GNU General Public License Version 3: http://www.gnu.org/licenses/gpl.txt