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:

        $ npm install

  2. Execute the benchmark suite:

        $ 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 and Python installed.

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

        $ npm install

  3. Build browser version of PEG.js:

        $ make browser

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

        $ python -m SimpleHTTPServer

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

  6. Click the **Run** button and wait for results.
Added a benchmark suite. 2010-03-29 20:18:54 +02:00			`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`
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`optimizations.`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`Running in Node.js`
			`------------------`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`All commands in the following steps need to be executed in PEG.js root directory`
			`(one level up from this one).`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`1. Install all PEG.js dependencies, including development ones:`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`$ npm install`
Git repo npmization: Make the repo a npm package Includes: * Moving the source code from /src to /lib. * Adding an explicit file list to package.json * Updating the Makefile. * Updating the spec and benchmark suites and their READMEs. Part of a fix for GH-32. 2012-11-10 14:21:14 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`2. Execute the benchmark suite:`
Git repo npmization: Make the repo a npm package Includes: * Moving the source code from /src to /lib. * Adding an explicit file list to package.json * Updating the Makefile. * Updating the spec and benchmark suites and their READMEs. Part of a fix for GH-32. 2012-11-10 14:21:14 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`$ make spec`
Git repo npmization: Make the repo a npm package Includes: * Moving the source code from /src to /lib. * Adding an explicit file list to package.json * Updating the Makefile. * Updating the spec and benchmark suites and their READMEs. Part of a fix for GH-32. 2012-11-10 14:21:14 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`3. Wait for results.`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Use sentence case consistently in {spec,benchmark}/README.md headers 2014-05-10 16:40:39 +02:00			`Running in the Browser`
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`----------------------`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`All commands in the following steps need to be executed in PEG.js root directory`
			`(one level up from this one).`
Added a benchmark suite. 2010-03-29 20:18:54 +02:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`1. Make sure you have Node.js and Python installed.`
Add command-line runner for the benchmark suite 2011-01-26 12:53:58 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`2. Install all PEG.js dependencies, including development ones:`
Add command-line runner for the benchmark suite 2011-01-26 12:53:58 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`$ npm install`
Add command-line runner for the benchmark suite 2011-01-26 12:53:58 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`3. Build browser version of PEG.js:`
Add command-line runner for the benchmark suite 2011-01-26 12:53:58 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`$ make browser`
Add command-line runner for the benchmark suite 2011-01-26 12:53:58 +01:00
Rewrite benchmark/README.md More clarity, better grammar (hopefully). 2014-05-09 15:06:32 +02:00			`4. Serve PEG.js root directory using a web server:`

			`$ python -m SimpleHTTPServer`

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

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