Convert spec/README to Markdown

It will look nicer on GitHub.
redux
David Majda 10 years ago
parent 85c8f386c1
commit 24e1644c58

@ -8,35 +8,37 @@ Running in a browser
-------------------- --------------------
1. Make sure you have Node.js and all the development dependencies specified 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 2. Run the following command in the PEG.js root directory (one level up from
this one): this one):
make browser make browser
3. Start a web server and make it serve the PEG.js root directory. 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. Watch the specs pass (or fail). 5. Watch the specs pass (or fail).
If you have Python installed, you can fulfill steps 3 and 4 by running the If you have Python installed, you can fulfill steps 3 and 4 by running the
following command in the PEG.js root directory following command in the PEG.js root directory
python -m SimpleHTTPServer python -m SimpleHTTPServer
and loading http://localhost:8000/spec/index.html in your browser. and loading
[http://localhost:8000/spec/index.html](http://localhost:8000/spec/index.html)
in your browser.
Running from a command-line Running from a command-line
--------------------------- ---------------------------
1. Make sure you have Node.js and all the development dependencies specified 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 2. Run the following command in the PEG.js root directory (one level up from
this one): this one):
make spec make spec
3. Watch the specs pass (or fail). 3. Watch the specs pass (or fail).
Loading…
Cancel
Save