summaryrefslogtreecommitdiffstats
path: root/tools/browsertime/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--tools/browsertime/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/tools/browsertime/README.md b/tools/browsertime/README.md
new file mode 100644
index 0000000000..bd76cf65be
--- /dev/null
+++ b/tools/browsertime/README.md
@@ -0,0 +1,15 @@
+===========
+Browsertime
+===========
+
+This code is obtained from `https://github.com/sitespeedio/browsertime` and all
+changes to the code must be made there. It's installed through `./mach browsertime --setup`
+and it's used when running `./mach browsertime` or through raptor with
+`./mach raptor --browsertime`.
+
+You can update this code by running `./mach browsertime --update-upstream-url <URL>`, where
+URL is a link to a github tarball of a particular commit in the aforementioned repository.
+
+For more information, you can consult the wiki `https://wiki.mozilla.org/TestEngineering/Performance/Raptor/Browsertime`.
+If you have any questions about this code, or browsertime, you can find us in
+`#browsertime`, or `#perftest` in Riot.