From c9037c4a079021a2d27b3af09fb93103cb2acebb Mon Sep 17 00:00:00 2001 From: Hannes Verschore Date: Fri, 24 Mar 2017 14:12:24 +0100 Subject: [PATCH] Update README.md --- README.md | 65 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index 5eae64c..d9a21de 100644 --- a/README.md +++ b/README.md @@ -9,69 +9,10 @@ over time. A public instance is hosted by Mozilla and running at [https://arewefastyet.com](https://arewefastyet.com). -Components -========== +Full Documentation +================== -Slave: - -1. Builder: A python driver (build.py) that can create shell builds of - spidermonkey/jsc/v8. -2. Downloader: A python driver (download.py) that can download browser builds - of Firefox. -3. Executor: (execute.py) is a python script that executes one or multiple - benchmarks on one or more builds. - -Site: - -1. Database: MySQL database that stores statistics. -2. Collector: Hidden PHP script on the webserver, where stats get sent. - (UPDATE.php in below diagram) -3. Processor: Python aggregator that builds JSON data from the DB. (update.py - in below diagram) -4. Website: Static HTML as the frontpage, that queries JSON via XHR. -5. Command center: Sends commands to the slaves on what to execute. (In - construction.) - -Components (2) and (4) must be on the same webserver, otherwise timestamps -might not be computed correctly. - -Keep in mind, most of this documentation is for posterity. AWFY was never -intended to be a drag-and-drop all-in-one released product, so the procedures -and scripts may be pretty rough. - -System Diagram -============== - -![Alt text](/docs/awfy_system_diagram.png "System Diagram") - - -Benchmark locally -================= - -1. Fetch the repo -2. Create a (shell) or retrieve a (browser) build to benchmark - * Creating a build: - ``` - cd slave - python build.py -s mozilla - ``` - - * Pull a build: - - ``` - cd slave - python download.py http://archive.mozilla.org/pub/mozilla.org/firefox/tinderbox-builds/mozilla-inbound-linux/latest/ - ``` - -3. Benchmark - - ``` - python execute.p -b remote.octane -b remote.kraken - ``` +See the [Wiki](https://github.com/h4writer/arewefastyet/wiki/) for full documentation, examples, operational details and other information. Installation ============