Bug 1642964 - Add small README file to tools/browsertime. r=tarek
authorGregory Mierzwinski <gmierz2@outlook.com>
Wed, 03 Jun 2020 12:51:41 +0000
changeset 533708 6f321568428f4b345140d117cf67f76ae0dd1846
parent 533707 595f4258afb4cec9867a4e4d4f9a6773a8da4c68
child 533709 7a77bd49f8950b0cee5c3f13c6d827793e928edb
push id37476
push userccoroiu@mozilla.com
push dateWed, 03 Jun 2020 21:49:22 +0000
treeherdermozilla-central@66d3efe9fc7a [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerstarek
bugs1642964
milestone79.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1642964 - Add small README file to tools/browsertime. r=tarek This patch adds a small README file to the tools/browsertime folder to give people more information about its purpose and provides a link to the perftest wiki. Depends on D78044 Differential Revision: https://phabricator.services.mozilla.com/D78045
tools/browsertime/README.md
new file mode 100644
--- /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.