Updated readme about running or creating new test cases

This commit is contained in:
tstone 2012-06-13 23:05:44 -06:00
parent d16e675ae8
commit ee929c4fe5

View File

@ -17,7 +17,7 @@ Showdown, at least as it exists on GitHub.
Apologies for any confusion or perceived misinformation. Apologies for any confusion or perceived misinformation.
Cheers, Cheers,
Corey Corey
@ -191,23 +191,34 @@ In most cases, Showdown's output is identical to that of Perl Markdown v1.0.2b7.
Showdown won't. But still, don't do that. Showdown won't. But still, don't do that.
Tests
---------------------------
A suite of tests is available which require node.js. Once node is installed, run the following command from the project root to install the development dependencies:
npm install --dev
Once installed the tests can be run from the project root using:
mocha test/run.js
Credits Credits
--------------------------- ---------------------------
* Origins * Origins
* [John Fraser](http://http://attacklab.net/): * [John Fraser](http://http://attacklab.net/):
Author of Showdown Author of Showdown
* [John Gruber](http://daringfireball.net/projects/markdown/): * [John Gruber](http://daringfireball.net/projects/markdown/):
Author of Markdown Author of Markdown
* Maintenance * Maintenance
* [Corey Innis](http://github.com/coreyti): * [Corey Innis](http://github.com/coreyti):
GitHub project maintainer GitHub project maintainer
* [Remy Sharp](http://remysharp.com/): * [Remy Sharp](http://remysharp.com/):
CommonJS-compatibility and more CommonJS-compatibility and more
* [Roger Braun](https://github.com/rogerbraun): * [Roger Braun](https://github.com/rogerbraun):
Github-style code blocks Github-style code blocks
* [Dominic Tarr](https://github.com/dominictarr): * [Dominic Tarr](https://github.com/dominictarr):
Documentation Documentation
* [Cat Chen](https://github.com/CatChen): * [Cat Chen](https://github.com/CatChen):
Export fix Export fix