diff --git a/README.md b/README.md index c45b359..d5ac343 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -# otime -Rewrite of CTime by Casey Muratori in Odin -Latest tested with 'Odin v0.0.5e' +# Otime +This program is a spirital successor for Casey Muratori's Ctime written in Odin +``` +otime -stats jaze.otm + +Stats from jaze.otm. + +Total timings: 6436. +Total incomplete timings: 107. + +Timings marked successful (2701): + Slowest: 22.326 seconds + Fastest: 0.046 seconds + Average: 2.443 seconds + Total: 1 hour, 50 minutes, 0.810 seconds + +Timings marked failed (3628): + Slowest: 1 minute, 46.796 seconds + Fastest: 0.016 seconds + Average: 0.609 seconds + Total: 36 minutes, 52.238 seconds + +Average of all groups: 1.369 seconds +Total of all groups: 2 hours, 26 minutes, 53.048 seconds +``` +# Usage +Otime will automatically create a file to store the data in when you start timing stuff. +You simply put a `otime -begin foo` and `otime -end foo.otm %err%` around what you're timing, with foo being the filename you want otime to use, and `%err%` being the error code returned by what you're timing, you can omit `%err%` and otime will just assume that the timing was successful. +If want to see all options just write `otime` and it will print them.