diff --git a/README.md b/README.md index 97b3658..b628327 100755 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # Bootstrap - Performance Analysis -This repository is for analyzing the performance of various versions of the [bootstrap framework](https://github.com/twbs/bootstrap) using [telemetry](http://www.chromium.org/developers/telemetry). +This repository is for analyzing the rendering performance of various versions and components of the [bootstrap framework](https://github.com/twbs/bootstrap) using [browser-perf](http://github.com/axemclion/browser-perf). -## Running the code -To run telemetry against this repository, +> View results at http://axemclion.github.io/bootstrap-perf -1. Install all NPM dependencies -2. [Download]() and run selenium with drivers for Chrome or any other browsers. -3. Run `grunt --verbose` -4. The grunt file will automatically connect to the selenium server and run the tests -5. The results will be available as a couch app at the URL specified in the grunt file. +More information in a [blog post](http://blog.nparashuram.com/2013/08/bootstrap-evolution-over-two-years.html) talking about how the system works. -## More Info -* [Blog post](http://blog.nparashuram.com/2013/08/bootstrap-evolution-over-two-years.html) talking about how the system works +## Running the tests -## Details +1. Download and install [CouchDB](http://couchdb.apache.org/) and [Selenium](https://github.com/axemclion/browser-perf/wiki/Setup-Instructions#installing-and-running-selenium). +2. Clone the repository and install all dependencies `npm install` +3. Run `node lib/cli.js`. +4. All tests are run against selenium running at `http://localhost:4444/wd/hub` and results are stored in a CouchDB server at `http://localhost:5984/bootstrap-perf`. To change any of these, edit the `lib/index.js` file appropriately. -This repository has almost all versions of bootstrap. It creates HTML pages and uses the `smoothness_benchmark` to see how each version performs, for every component. +Run `node lib/cli.js --help` to view other options to run the tests. Test can be run against specific versions and specific components. + +## How does it work ? +This repository runs scroll tests on each component of bootstrap. It creates a simple HTML file for each component, where each component is repeated 200 times. This webpage is opened in a browser and the page is scrolled to see the impact of CSS/JS by the Bootstrap library. Look at [browser-perf](https://github.com/axemclion/browser-perf/wiki) for more information about the tests, and [perfjankie](http://github.com/axemclion/perfjankie) to see how the UI/Graphs are plotted. _ Inspired by the awesome perf done in the [Topcoat.io](https://github.com/topcoat/topcoat/tree/master/dev/test/perf/telemetry) repository. Trying to do the same thing for bootstrap _