1 files changed, 19 insertions, 4 deletions
diff --git a/tools/reproduceriter.py b/tools/reproduceriter.py
index 89fcc41c..a1912396 100755
--- a/tools/reproduceriter.py
+++ b/tools/reproduceriter.py
@@ -1,9 +1,6 @@
 #!/usr/bin/env python
 
 '''
-
-* This is a work in progress *
-
 Reproducer Rewriter
 ===================
 
@@ -30,7 +27,8 @@ Usage:
    specified, we will make a build that runs in the shell and not in
    a browser. WINDOW_LOCATION is the fake window.location we set in the
    fake DOM, and ON_IDLE is code that runs when the fake main browser
-   event loop runs out of actions.
+   event loop runs out of actions. (Note that only a browser build can
+   do recording, shell builds just replay.)
 
    You will need to call
 
@@ -86,7 +84,24 @@ Examples
 
     emscripten/tools/reproduceriter.py bb bench js/game-setup.js game.html?low,low,reproduce=repro.data "function(){ print('triggering click'); document.querySelector('.fullscreen-button.low-res').callEventListeners('click'); window.onIdle = null; }"
 
+   for a shell build, or
+
+    emscripten/tools/reproduceriter.py bb bench js/game-setup.js 
+
+   for a browser build. Since only a browser build can do recording, you would normally
+   make a browser build, record a trace, then make a shell build and copy the trace
+   there so you can run it.
+
    The last parameter specifies what to do when the event loop is idle: We fire an event and then set onIdle (which was this function) to null, so this is a one-time occurence.
+
+Notes
+
+ * Replay can depend on browser state. One case is if you are replaying a fullscreen
+   game with pointer lock, then you will need to manually allow pointer lock if it
+   isn't already on for the machine. If you do it too early or too late, the replay
+   can be different, since mousemove events mean different things depending on
+   whether the pointer is locked or not.
+
 '''
 
 import os, sys, shutil, re