Update quickstart

Signed-off-by: Chen Wang <[email protected]>
uiuc-hpc · Jun 11, 2024 · 360fd1a · 360fd1a
1 parent 5f37d0f
commit 360fd1a
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -75,7 +75,14 @@ It's folder name follows the format of ``HHmmSS.ff-hostname-username-appname-pid
 **3. Examine the traces**
 
 Recorder provides several useful tools under ``$RECORDER_ROOT$/bin`` for analysis purposes.
-Among them, *recorder2text* is used to convert the Recorder-format traces to plain text files.
+
+*recorder-summary* can be used to reports high-level statistics:
+
+.. code:: bash
+
+   $RECORDER_ROOT/bin/recorder-summary /path/to/your_trace_folder/
+
+*recorder2text* is used to convert the Recorder-format traces to plain text files.
 
 .. code:: bash