diff --git a/benchmark/README b/benchmark/README.md similarity index 74% rename from benchmark/README rename to benchmark/README.md index 25d391e..ea3f217 100644 --- a/benchmark/README +++ b/benchmark/README.md @@ -9,35 +9,37 @@ Running in a browser -------------------- 1. Make sure you have Node.js and all the development dependencies specified - in package.json installed. + in `package.json` installed. 2. Run the following command in the PEG.js root directory (one level up from this one): - make browser + make browser 3. Start a web server and make it serve the PEG.js root directory. - 4. Point your browser to an URL corresponding to the index.html file. + 4. Point your browser to an URL corresponding to the `index.html` file. 5. Click the "Run" button and wait for the table to fill. If you have Python installed, you can fulfill steps 3 and 4 by running the following command in the PEG.js root directory - python -m SimpleHTTPServer + python -m SimpleHTTPServer -and load http://localhost:8000/benchmark/index.html in your browser. +and load +[http://localhost:8000/benchmark/index.html](http://localhost:8000/benchmark/index.html) +in your browser. Running from a command-line --------------------------- 1. Make sure you have Node.js and all the development dependencies specified - in package.json installed. + in `package.json` installed. 2. Run the following command in the PEG.js root directory (one level up from this one): - make benchmark + make benchmark 3. Wait for the table to fill.