Update Readme

README.md

@@ -1,6 +1,8 @@
-# cptnHookLite
-A tool tostudy the input value of mathematical functions.
-This version of cptnHook is inspired by https://github.com/emyrto/cptnHook but does not use cctlib nor PIN.
+# CptnHook
+A profiler to investigate the usage patterns of mathematical functions capturing the input values and the stacktraces which lead to it.
+No code instrumentation nor recompilation is needed: the principle behind CtpnHook is library preload.
+The principle is to save in a profile for every mathematical function (both for single and double precision) a two column n-tuple containing the input value and a stacktrace ID. The map between the IDs and the stacktraces themselves is saved as well.
+This version of cptnHook is inspired by https://github.com/emyrto/cptnHook but is standalone: it does not depend on any external library such as cctlib or PIN.
 
 ## How to build
 Clone the repository and then:
@@ -16,18 +18,24 @@ export PATH=`pwd`:$PATH
 ~~~
 cptnhook -o myFirstProfile -- myprogram --arg1 --arg2 arg3
 ~~~
-This will generate a directory called `myFirstProfile` containing the raw profile.
+This will generate a directory called `myFirstProfile` containing the raw profile. The information
 
-### Converting to ROOT format
-Make sure to have ROOT installed. Then there are two ways of converting to ROOT format the raw profile.
+## How to produce a report
+~~~
+cptnhook-analyze myFirstProfile
+~~~
+
+
+### Converting to [ROOT](http://root.cern.ch) format
+Make sure to have [ROOT](http://root.cern.ch) installed. Then there are two ways of converting to [ROOT](http://root.cern.ch) format the raw profile.
 Either manually with a script
 ~~~
-cptnhookAnalyze --root myFirstProfile
+cptnhook-analyze --root myFirstProfile
 ~~~
 or directly specifying this in the invocation of cptnhook
 ~~~
 cptnhook -o myFirstProfile --root -- myprogram --arg1 --arg2 arg3
 ~~~
 
-## How to produce a report
-This is still work inprogress. At the moment you can study the ROOT file by hand.
+## [MetaLibm](http://www.metalibm.org/ANRMetaLibm/)
+CptnHook has been developed in the context of the [MetaLibm](http://www.metalibm.org/ANRMetaLibm/) project, financed by [French National Research Agency (ANR)](http://www.agence-nationale-recherche.fr/en/).