Add link script and docu to facilitate developing mocha-given #4

rendro · Jul 14, 2014 · 5e23d8b · 5e23d8b
1 parent 25be07a
commit 5e23d8b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -20,7 +20,8 @@
   },
   "scripts": {
     "prepublish": "./node_modules/.bin/coffee -cbo browser lib/mocha-given.coffee",
-    "test": "./node_modules/.bin/mocha -u mocha-given --compilers coffee:coffee-script -R spec"
+    "test": "./node_modules/.bin/mocha -u mocha-given --compilers coffee:coffee-script -R spec",
+    "link": "mkdir -p node_modules/mocha-given && cd node_modules/mocha-given && ln -s ../../package.json package.json && ln -s ../../index.js index.js && ln -s ../../lib lib && cd -"
   },
   "keywords": [
     "mocha",

diff --git a/readme.md b/readme.md
@@ -53,6 +53,20 @@ you have to call the mocha binary directly:
 $ ./node_modules/.bin/mocha -u mocha-given --compilers coffee:coffee-script -R spec
 ```
 
+## Run mocha-given tests & start contributing
+
+To run the `mocha-given` tests for developing, it has to be symlinked into the `node_modules` folder to enable `mocha` to resolve `mocha-given`.
+
+Therefore run the script:
+
+```
+$ npm run link
+```
+
+Afterwards `mocha` has to be installed with ` $ npm install mocha`.
+
+Now you can run the tests using `$ npm tests` and start contributing.
+
 ## Run tests programmatically
 
 ``` javascript