Unit tests for the MOTD MKWS-134

[mkws-moved-to-github.git] / notes / developers.txt

diff --git a/notes/developers.txt b/notes/developers.txt
index 82729f2..66ee39a 100644 (file)
--- a/notes/developers.txt
+++ b/notes/developers.txt
@@ -4,6 +4,14 @@ These notes are collected by Heikki, mostly from skype chats with Wolfram
 and Mike. I collected them for my own use, but I hope they will turn out
 to be helpful to anyone who needs to get started with mkws.
 
+Environment
+-----------
+
+apt-get install yui-compressor
+get nodejs, sudo make install, ln -s /usr/local/bin/npm ~/bin/npm if needed
+
+cd .../mkws; make check
+
 
 Libraries
 ---------
@@ -54,9 +62,18 @@ Most (all?) code work happens in mkws.js.
 Unit tests
 ----------
 
-if you want understand the test than you can look at mkws/test/spec/mkws-config.js
+Tests are based on jasmine. a general description of jasmine is on
+http://jasmine.github.io/1.3/introduction.html
+
+If you want understand the test than you can look at mkws/test/spec/mkws-config.js
 and mkws/test/spec/mkws-pazpar2.js . See also mkws/test/README.txt
 
+The test scripts are included from the test page, for example
+mkws/examples/htdocs/jasmine-popup.html has 
+<script type="text/javascript" src="test/spec/mkws-pazpar2.js"></script>
+
+
+
 
 Structure of mkws.js
 --------------------