README: add more links/information

Help people learn how to download and contribute to the project.

Change-Id: I4b88b9b3872485ce78c7f6ea50596228afd82843
Reviewed-on: https://go-review.googlesource.com/49870
Reviewed-by: Miguel Bernabeu <miguelbernadi@gmail.com>
Reviewed-by: Kevin Burke <kev@inburke.com>
1 file changed
tree: 11e58eb2362c967fc85817de0cdcab0e9a48e2a0
  1. AUTHORS
  2. CONTRIBUTING.md
  3. CONTRIBUTORS
  4. LICENSE
  5. PATENTS
  6. README.md
  7. analysis/
  8. benchstat/
  9. cmd/
  10. internal/
  11. storage/
  12. vendor/
README.md

Go performance measurement, storage, and analysis tools

This subrepository holds the source for various packages and tools related to performance measurement, storage, and analysis.

cmd/benchstat contains a command-line tool that computes and compares statistics about benchmarks.

cmd/benchsave contains a command-line tool for publishing benchmark results.

storage contains the https://perfdata.golang.org/ benchmark result storage system.

analysis contains the https://perf.golang.org/ benchmark result analysis system.

Both storage and analysis can be run locally; the following commands will run the complete stack on your machine with an in-memory datastore.

go get -u golang.org/x/perf/storage/localperfdata
go get -u golang.org/x/perf/analysis/localperf
localperfdata -addr=:8081 -view_url_base=http://localhost:8080/search?q=upload: &
localperf -addr=:8080 -storage=http://localhost:8081

The storage system is designed to have a standardized API, and we encourage additional analysis tools to be written against the API. A client can be found in the storage package.

Download/Install

The easiest way to install is to run go get -u golang.org/x/perf. You can also manually git clone the repository to $GOPATH/src/golang.org/x/perf.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The main issue tracker for the perf repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/perf:” in the subject line, so it is easy to find.