summaryrefslogtreecommitdiff
path: root/src/trace_viewer/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/trace_viewer/README')
-rw-r--r--src/trace_viewer/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/trace_viewer/README b/src/trace_viewer/README
new file mode 100644
index 00000000..547a1435
--- /dev/null
+++ b/src/trace_viewer/README
@@ -0,0 +1,11 @@
+
+To use, first make sure node.js and npm are installed (e.g. via the
+Ubuntu package manager), then run the following in this directory:
+
+> npm install
+
+> npm run tsc
+
+> ./node_modules/.bin/electron .
+
+and point the file selector at a trace produced by sail -ocaml_trace \ No newline at end of file