Permalink
Browse files

Add some info about testin and building to the README

  • Loading branch information...
1 parent 8066dd8 commit 4f34f8d9d5158c47d64d6034b2de35865cd0906e @arian committed May 1, 2012
Showing with 20 additions and 3 deletions.
  1. +2 −2 Makefile
  2. +16 −0 README.md
  3. +2 −1 package.json
View
4 Makefile
@@ -2,11 +2,11 @@
all: test build build-min
build:
- @wrup -r ./ > classy.js
+ @./node_modules/wrapup/bin/wrup.js -r ./ > classy.js
@echo "Browser version written to 'classy.js'"
build-min:
- @wrup -r ./ --compress > classy.min.js
+ @./node_modules/wrapup/bin/wrup.js -r ./ --compress > classy.min.js
@echo "Browser version written to 'classy.min.js'"
test:
View
16 README.md
@@ -25,3 +25,19 @@ I would advice to use the basic `prime` wherever possible.
- Class.Bind (by @cpojer)
-
+### Building and testing
+
+To test and build Classy run:
+
+ # run this once to install the devDependencies (wrapup and mocha)
+ npm install -d
+
+ # install other dependencies (MooTools prime)
+ npm install
+
+ make
+
+Other targets in the Makefile are `build`, `build-min` or `test`.
+
+Testing is done with [mocha](http://visionmedia.github.com/mocha/), and building is done by [wrapup](https://github.com/kamicane/wrapup).
+
View
3 package.json
@@ -12,7 +12,8 @@
"dependencies": {},
"devDependencies": {
"expect.js": "0.1",
- "mocha": "1.0"
+ "mocha": "1.0",
+ "wrapup": "0.9"
},
"optionalDependencies": {},
"scripts": {

0 comments on commit 4f34f8d

Please sign in to comment.