test:note: add 0x05120005 to doctest

[hooke.git] / README

diff --git a/README b/README
index 3ab3fa93d852dd2b7284b4766043b75f9da17d73..e2c665cd2f98cca8dec9bd94d03293e1c6a6684e 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,7 @@
-What is it?
-===========
+.. -*- coding: utf-8 -*-
+
+What it is
+==========
 
 It is a software for the (semiautomatic) analysis and filtering of
 force curves. Force curves are the output of an analytical technique
@@ -8,21 +10,30 @@ requires the analysis of thousands of force curves at a time. As of
 today, there is no standard, free software for the analysis of force
 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
+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
+
+See `Hooke's Google Code homepage`_ for more details.
+
 
-See the Google Code website for more details
-  http://code.google.com/p/hooke/
+How it works
+============
 
-Is this published in some peer-reviewed journal?
-================================================
+See the ``doc/tutorial.txt`` file distributed with Hooke, or the
+`online docs`__.
+
+__ docs_
+
+Where it's published
+====================
 
 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
 "Hooke: an open software platform for force spectroscopy."
@@ -31,13 +42,18 @@ doi:10.1093/bioinformatics/btp180
 
 Please cite Hooke if you use it.
 
+
 Troubleshooting
 ===============
 
 If you have troubles in using it, before throwing it in the trash:
-  1) try look at the TroubleShooting page or in the discussion group
-  2) ask a question in 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.
+
 
 Disclaimer
 ==========
@@ -45,5 +61,31 @@ Disclaimer
 Remember that Hooke is still experimental software! It has been mostly
 done to fit the needs of its authors, and there is no guarantee it
 will do what you need. However, you can write us/help us improve it so
-that it does. We aim to make of Hooke a little, universal tool that
-can help your research.
+that it does. We aim to make of Hooke a robust tool that can help your
+research.
+
+
+Source
+======
+
+Hooke is available as a Git_ repository::
+
+    $ git clone git://tremily.us/hooke.git
+
+See the docs_ for installation details.
+
+
+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.
+
+.. _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/