From 58f0f2341739469f50152c2c6ea7e69b2bb93c0c Mon Sep 17 00:00:00 2001 From: David Beniamine <david.beniamine@tetras-libre.fr> Date: Tue, 12 Jan 2021 14:25:51 +0100 Subject: [PATCH] Doc up --- Readme.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index dda026a..dab7b6c 100644 --- a/Readme.md +++ b/Readme.md @@ -67,8 +67,8 @@ setup( ## Usage ```python -from pyTiming.pyTiming import timer -timer = timer() # starts measuring time +from pyTiming import pyTiming +timer = pyTiming.timer() # starts measuring time . . . timer.start_step('step1') @@ -89,3 +89,5 @@ timer.end() # end all measurements print(timer.get_analysis()) ``` + +**Warning** do not call a step `'main'` as this name is used for the global step -- GitLab