summaryrefslogtreecommitdiff
path: root/benchmark/README.md
diff options
context:
space:
mode:
authorBartosz Sosnowski <bartosz@janeasystems.com>2016-09-26 11:03:21 +0200
committerJames M Snell <jasnell@gmail.com>2016-09-30 08:24:16 -0700
commit3e7da1d7a24d766d3ea36cc8cb8bb4e478176c68 (patch)
tree79419c47a2520a2e0172a092edbde75ed2c2daae /benchmark/README.md
parent21b37b23c1bf29b7b07b90186c46112e09afccc3 (diff)
downloadandroid-node-v8-3e7da1d7a24d766d3ea36cc8cb8bb4e478176c68.tar.gz
android-node-v8-3e7da1d7a24d766d3ea36cc8cb8bb4e478176c68.tar.bz2
android-node-v8-3e7da1d7a24d766d3ea36cc8cb8bb4e478176c68.zip
benchmark: add info about required Unix tools
This adds note to README.md about Unix tools being required by some benchmarks PR-URL: https://github.com/nodejs/node/pull/8788 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'benchmark/README.md')
-rw-r--r--benchmark/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/benchmark/README.md b/benchmark/README.md
index 770df01837..1012ac898f 100644
--- a/benchmark/README.md
+++ b/benchmark/README.md
@@ -34,6 +34,10 @@ benchmarker to be used by providing it as an argument, e. g.:
`node benchmark/http/simple.js benchmarker=autocannon`
+Basic Unix tools are required for some benchmarks.
+[Git for Windows][git-for-windows] includes Git Bash and the necessary tools,
+which need to be included in the global Windows `PATH`.
+
To analyze the results `R` should be installed. Check you package manager or
download it from https://www.r-project.org/.
@@ -348,3 +352,4 @@ Supported options keys are:
[autocannon]: https://github.com/mcollina/autocannon
[wrk]: https://github.com/wg/wrk
[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances
+[git-for-windows]: http://git-scm.com/download/win \ No newline at end of file