Add & Update READMEs.

Author: Mark-Simulacrum

README.md

@@ -0,0 +1,12 @@
+# Rust Compiler Performance Monitoring & Benchmarking
+
+This repository contains two primary crates: `collector` and `site`. Collector gathers data for each
+bors commit and the site displays the data.
+
+The primary required setup is to provide a folder with a `retries` file and a `times` folder. Data
+is gathered into https://github.com/rust-lang-nursery/rustc-timing by Rust Infrastructure; cloning
+that is the best approach for working on the frontend.
+
+Additional documentation on running and setting up the frontend and backend can be found in README
+files in the `collector` and `site` directories.
+

collector/README.md

@@ -2,42 +2,29 @@
 
 Implements running benchmarks given a bors commit hash.
 
-## Setup
-
-Utilizes native-tls crate through reqwest to allow running on most platforms. If running on Ubuntu,
-please install openssl (libssl-dev).
-
-A file, `last-commit-sha`, should be in the current directory when running the script and it should
-contain a single line, containing the SHA1 of the bors merge commit in the rust-lang/rust repository
-from which to start running. The script will automatically update it as it completes each commit
-since it. If starting from scratch, 83c2d95238e3545e7ae9af4873c48b1e3651c164 may be a good option
-(see below, this is the first commit we support).
-
 ## How to run
 
 ```
-RUST_LOG=info GH_API_TOKEN=<token> cargo run -- --benchmarks ./benchmarks process $RUSTC_TIMING
+# From repository root:
+cargo build -p collector --release
+./target/release/collector --benchmarks collector/benchmarks --output-repo $RUSTC_TIMING process
 ```
 
-GH_API_TOKEN should be a GitHub token, which is only used to reduce API rate limits, so should need
-extremely minimal rights (if any).
-
-$RUSTC_TIMING should point to a clone of the `https://github.com/rust-lang-nursery/rustc-timing` repository, with push access.
+$RUSTC_TIMING should point to a clone of the `https://github.com/rust-lang-nursery/rustc-timing`
+repository. Optionally, `--sync-git` can be passed to make the collector sync with the remote repo
+before and after comitting.
 
 ## How it works
 
 We download the artifacts (rustc, rust-std, cargo) produced by CI and properly unarchive them into
 the correct directories to allow cargo and rustc to function. Currently only
 x86_64-unknown-linux-gnu is supported, but the system should trivially expand to other platforms
-(e.g., Windows) should we want it, though generation and downloading of artifacts becomes necessary
-at that point.
+(e.g., Windows), though generation and downloading of artifacts becomes necessary at that point.
 
-## Limitations
+`perf` is used to gather most of the data.
 
-Will only work for commits that have builds on s3://rust-lang-ci/rustc-builds: these merged after #38748 (bors sha: 927c55d86b0be44337f37cf5b0a76fb8ba86e06c).
+## Limitations
 
-Subpasses are currently ignored completely, since their naming differs between different runs. No
-serious investigation as to why this is has been conducted, so it is possible that they could be
-re-enabled after additional investigation and improvements. The differences in names between runs
-make the code which attempts to average passes across runs to (at least theoretically) produce more
-accurate data break, since it cannot find the same pass in all runs.
+Will only work for commits that have builds on s3://rust-lang-ci/rustc-builds: these merged after
+rust-lang/rust#38748 (bors sha: 927c55d86b0be44337f37cf5b0a76fb8ba86e06c). Additionally, try builds
+can also be tested, but the process is currently manual.

site/README.md

@@ -8,10 +8,6 @@ which displays graphs to the user.
 https://github.com/rust-lang-nursery/rustc-timing contains the raw data
 from which rustc-perf pulls.
 
-https://github.com/rust-lang-nursery/rustc-benchmarks runs elsewhere and
-performs the tests whose results rustc-perf displays, then pushes them
-to the timings repo.
-
 Setup
 -----