pegjs/benchmark/README.md

PEG.js Benchmark Suite
======================

This is the PEG.js benchmark suite. It measures speed of the parsers generated
by PEG.js on various inputs. Its main goal is to provide data for code generator
optimizations.

Running in Node.js
------------------

All commands in the following steps need to be executed in PEG.js root directory
(one level up from this one).

  1. Install all PEG.js dependencies, including development ones:

     ```console
     $ npm install
     ```

  2. Execute the benchmark suite:

     ```console
     $ make spec
     ```

  3. Wait for results.

Running in the Browser
----------------------

All commands in the following steps need to be executed in PEG.js root directory
(one level up from this one).

  1. Make sure you have Node.js installed.

  2. Install all PEG.js dependencies, including development ones:

     ```console
     $ npm install
     ```

  3. Build browser version of PEG.js:

     ```console
     $ make browser
     ```

  4. Serve PEG.js root directory using a web server:

     ```console
     $ node_modules/.bin/http-server
     ```

  5. Point your browser to the [benchmark suite](http://localhost:8080/benchmark/index.html).

  6. Click the **Run** button and wait for results.