From ee929c4fe5f471ba7e899409748d6cb1389c6575 Mon Sep 17 00:00:00 2001 From: tstone Date: Wed, 13 Jun 2012 23:05:44 -0600 Subject: [PATCH] Updated readme about running or creating new test cases --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6d65593..2d98d63 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Showdown, at least as it exists on GitHub. Apologies for any confusion or perceived misinformation. -Cheers, +Cheers, 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. +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 --------------------------- * Origins - * [John Fraser](http://http://attacklab.net/): + * [John Fraser](http://http://attacklab.net/): Author of Showdown - * [John Gruber](http://daringfireball.net/projects/markdown/): + * [John Gruber](http://daringfireball.net/projects/markdown/): Author of Markdown * Maintenance - * [Corey Innis](http://github.com/coreyti): + * [Corey Innis](http://github.com/coreyti): GitHub project maintainer - * [Remy Sharp](http://remysharp.com/): + * [Remy Sharp](http://remysharp.com/): CommonJS-compatibility and more - * [Roger Braun](https://github.com/rogerbraun): + * [Roger Braun](https://github.com/rogerbraun): Github-style code blocks - * [Dominic Tarr](https://github.com/dominictarr): + * [Dominic Tarr](https://github.com/dominictarr): Documentation - * [Cat Chen](https://github.com/CatChen): + * [Cat Chen](https://github.com/CatChen): Export fix