Add doctests proving recursive curve->command_stack->arguments->curve serializing...

[hooke.git] / README

diff --git a/README b/README
index 3ab3fa93d852dd2b7284b4766043b75f9da17d73..3baf8c312c64a41cfb33e20984145ff87d4c9c2a 100644 (file)
--- a/README
+++ b/README
@@ -8,6 +8,7 @@ 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?
 =============
 
@@ -21,6 +22,15 @@ What it does?
 See the Google Code website for more details
   http://code.google.com/p/hooke/
 
+
+How do you make it work?
+========================
+
+See the doc/tutorial.txt file distributed with hooke, or the online
+docs:
+  http://www.physics.drexel.edu/~wking/rsrch/hooke/
+
+
 Is this published in some peer-reviewed journal?
 ================================================
 
@@ -31,13 +41,21 @@ 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.
+     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
+4. Ask a question in the discussion group.
+5. File a bug on the issue tracker.
+
 
 Disclaimer
 ==========
@@ -45,5 +63,13 @@ 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.
+
+
+Licensing
+=========
+
+Hooke is released under the GNU Lesser General Public License, either
+version 3 of the License (OBCOPYING and COPYING.LESSER), or (at your
+option) any later version.