X-Git-Url: http://git.tremily.us/?p=hooke.git;a=blobdiff_plain;f=README;h=c9be3aa90af2f6e587fe62de4ea31af31dc60b73;hp=3ab3fa93d852dd2b7284b4766043b75f9da17d73;hb=27f33e13788ecddb6b14eeec0e7f084d2b8f3a36;hpb=5c9e831f851ddb1cb9d0b06ff18c9d63ddf02aea diff --git a/README b/README index 3ab3fa9..c9be3aa 100644 --- 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 @@ -8,8 +8,9 @@ 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? -============= + +What it does +============ * View, annotate, measure force curves * Worm-like chain and freely-jointed chain fit of force peaks @@ -18,11 +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 +============ + +See the doc/tutorial.txt file distributed with Hooke, or the `online +docs`_. -Is this published in some peer-reviewed journal? -================================================ +.. _online docs: http://www.physics.drexel.edu/~wking/rsrch/hooke/ + + +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 +43,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 + `_. +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 +65,27 @@ 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. + + +.. _Git: http://git-scm.com/ +.. _docs: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Hooke/html/