Add `setup.py sdist` side effects to .gitignore.
[hooke.git] / README
diff --git a/README b/README
index bf9a32c6b246aec22b24b28e84e0c2f442b61d57..e2c665cd2f98cca8dec9bd94d03293e1c6a6684e 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,5 @@
+.. -*- coding: utf-8 -*-
+
 What it is
 ==========
 
@@ -12,26 +14,23 @@ curves. Hooke aims to solve that.
 What it does
 ============
 
-  * View, annotate, measure force curves
-  * Worm-like chain and freely-jointed chain fit of force peaks
-  * Automatic convolution-based filtering of empty curves
-  * Automatic fit and measurement of multiple force peaks
-  * Handles force-clamp force experiments (experimental)
-  * It is extensible by users by mean of plugins and drivers
+* View, annotate, measure force curves
+* Worm-like chain and freely-jointed chain fit of force peaks
+* Automatic convolution-based filtering of empty curves
+* Automatic fit and measurement of multiple force peaks
+* Handles force-clamp force experiments (experimental)
+* It is extensible by users by mean of plugins and drivers
 
 See `Hooke's Google Code homepage`_ for more details.
 
-.. _Hooke's Google Code homepage: http://code.google.com/p/hooke/
-
 
 How it works
 ============
 
-See the doc/tutorial.txt file distributed with Hooke, or the `online
-docs`_.
-
-.. _online docs: http://www.physics.drexel.edu/~wking/rsrch/hooke/
+See the ``doc/tutorial.txt`` file distributed with Hooke, or the
+`online docs`__.
 
+__ docs_
 
 Where it's published
 ====================
@@ -49,12 +48,9 @@ Troubleshooting
 
 If you have troubles in using it, before throwing it in the trash:
 
-1. Search the `issue tracker
-   <http://code.google.com/p/hooke/issues/list>`_.
-2. Look at the `troubleshooting wiki page
-   <http://code.google.com/p/hooke/wiki/TroubleShooting>`_.
-3. Search the `discussion group
-   <http://groups.google.com/group/hookesoftware>`_.
+1. Search the `issue tracker`_.
+2. Look at the `troubleshooting wiki page`_.
+3. Search the `discussion group`_.
 4. Ask a question in the discussion group.
 5. File a bug on the issue tracker.
 
@@ -72,9 +68,9 @@ research.
 Source
 ======
 
-Hooke is available as a Mercurial_ repository::
+Hooke is available as a Git_ repository::
 
-    $ hg clone http://www.physics.drexel.edu/~wking/code/hg/hooke/
+    $ git clone git://tremily.us/hooke.git
 
 See the docs_ for installation details.
 
@@ -83,9 +79,13 @@ Licensing
 =========
 
 Hooke is released under the GNU Lesser General Public License, either
-version 3 of the License (COPYING and COPYING.LESSER), or (at your
-option) any later version.
-
+version 3 of the License (``COPYING`` and ``COPYING.LESSER``), or (at
+your option) any later version.
 
-.. _Mercurial: http://mercurial.selenic.com/
-.. _docs: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Hooke/html/
+.. _Hooke's Google Code homepage: http://code.google.com/p/hooke/
+.. _docs: http://hooke.tremily.us/
+.. _issue tracker: http://code.google.com/p/hooke/issues/list
+.. _troubleshooting wiki page:
+  http://code.google.com/p/hooke/wiki/TroubleShooting
+.. _discussion group: http://groups.google.com/group/hookesoftware
+.. _Git: http://git-scm.com/