Merge pull request #894 from rylev/update-readmes

Update slightly out of date readmes

Author: Mark-Simulacrum

README.md

@@ -1,11 +1,8 @@
 # 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 and provides a GitHub bot for on-demand benchmarking.
-
-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/rustc-timing by Rust Infrastructure; cloning
-that is the best approach for working on the frontend.
+This repository contains two primary crates: 
+* [`collector`](./collector): gathers data for each bors commit
+* [`site`](./site): [displays](https://perf.rust-lang.org) the data and provides a GitHub bot for on-demand benchmarking
 
 Additional documentation on running and setting up the frontend and backend can
 be found in the `README` files in the `collector` and `site` directories.

site/README.md

@@ -1,33 +1,31 @@
-rustc-perf
-----------
+# rustc-perf Site
 
 This is the website for Rust compiler performance monitoring. The website
 contains a backend to process the raw data and expose it to the frontend,
 which displays graphs to the user.
 
 This also contains a GitHub bot to trigger on-demand benchmarking.
 
-Setup
------
+## Setup
 
 The site launches on port 2346 by default, which can be overridden by setting
 the `PORT` environment variable.
 
 ```
-sudo apt-get install git
 git clone https://github.com/rust-lang/rustc-perf.git
 ```
 
-Launching
----------
+## Launching
 
-If you've collected data locally, you will likely want to point the site at that
-local database.
+If you've collected data locally, you will likely want to point the site at a
+local database. By default, a database called results.db located at the root of 
+the project will be used. You can optionally pass a path to a database
+if you don't want to use the default.
 
 ```
 cargo run --bin site --release <database>
 ```
 
-The release flag is on purpose, reducing startup time 15x from roughly 15
+The `--release` flag is on purpose, reducing startup time 15x from roughly 15
 seconds to 1; this is on the production database and smaller data sets are
 likely to load considerably faster.