Update docs to point to Git repository.

[hooke.git] / README

diff --git a/README b/README
index 3baf8c312c64a41cfb33e20984145ff87d4c9c2a..c9be3aa90af2f6e587fe62de4ea31af31dc60b73 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-What is it?
-===========
+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
@@ -9,8 +9,8 @@ today, there is no standard, free software for the analysis of force
 curves. Hooke aims to solve that.
 
 
-What it does?
-=============
+What it does
+============
 
   * View, annotate, measure force curves
   * Worm-like chain and freely-jointed chain fit of force peaks
@@ -19,20 +19,22 @@ What it does?
   * Handles force-clamp force experiments (experimental)
   * It is extensible by users by mean of plugins and drivers
 
-See the Google Code website for more details
-  http://code.google.com/p/hooke/
+See `Hooke's Google Code homepage`_ for more details.
+
+.. _Hooke's Google Code homepage: http://code.google.com/p/hooke/
+
 
+How it works
+============
 
-How do you make it work?
-========================
+See the doc/tutorial.txt file distributed with Hooke, or the `online
+docs`_.
 
-See the doc/tutorial.txt file distributed with hooke, or the online
-docs:
-  http://www.physics.drexel.edu/~wking/rsrch/hooke/
+.. _online docs: http://www.physics.drexel.edu/~wking/rsrch/hooke/
 
 
-Is this published in some peer-reviewed journal?
-================================================
+Where it's published
+====================
 
 Sandal M, Benedetti F, Brucale M, Gomez-Casado A, Samorì B.
 "Hooke: an open software platform for force spectroscopy."
@@ -47,12 +49,12 @@ 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 trouble shooting 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
+   <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>`_.
 4. Ask a question in the discussion group.
 5. File a bug on the issue tracker.
 
@@ -67,9 +69,23 @@ 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 (OBCOPYING and COPYING.LESSER), or (at your
+version 3 of the License (COPYING and COPYING.LESSER), or (at your
 option) any later version.
+
+
+.. _Git: http://git-scm.com/
+.. _docs: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Hooke/html/