Update.
authorFrancois Fleuret <francois@fleuret.org>
Mon, 5 Dec 2016 22:43:40 +0000 (23:43 +0100)
committerFrancois Fleuret <francois@fleuret.org>
Mon, 5 Dec 2016 22:43:40 +0000 (23:43 +0100)
README.md

index 2bb3011..24cf063 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 
 This is a simple profiler to estimate processing time per module per function.
 
 
 This is a simple profiler to estimate processing time per module per function.
 
+It seems to work okay, but there was no heavy testing so far. See test-profiler.lua for a short example.
+
 ### profiler.decorate(model, [functionsToDecorate]) ###
 
 This function should be called before starting the computation.
 ### profiler.decorate(model, [functionsToDecorate]) ###
 
 This function should be called before starting the computation.
@@ -12,9 +14,3 @@ It also resets the accumulated timings to zero.
 ### profiler.print(model, [nbSamples]) ###
 
 Prints the measured processing times. If nbSamples is provided, the time per samples will also be printed.
 ### profiler.print(model, [nbSamples]) ###
 
 Prints the measured processing times. If nbSamples is provided, the time per samples will also be printed.
-
-It seems to work okay, but there was no heavy testing so far.
-
---
-Francois Fleuret
-Dec 5th, 2016