Testing a commit on the "mike" branch

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

diff --git a/notes/developers.txt b/notes/developers.txt
index 82729f2..623059a 100644 (file)
--- a/notes/developers.txt
+++ b/notes/developers.txt
@@ -1,9 +1,29 @@
-Notes for developers
+xNotes for developers

 
 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.
 
 
 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
+
+
+Apache
+------
+You need to set up a local apache. 
+  * add 'mkws' in /etc/hosts to point to 127.0.0.2
+  * symlinked .../mkws/tools/apache2/mkws-heikki to /etc/apache/sites-available
+  * a2ensite mkws-heikki
+  * a2enmod rewrite
+  * a2enmod headers
+  * service apache2 reload
+  * Check that your browser sees somethig in http://mkws/ and 
+    http://mkws/jasmine-popup.html. If need be, enable javascript etc. 

 
 Libraries
 ---------
 
 Libraries
 ---------

@@ -25,7 +45,7 @@ test page, wait 3 seconds for success and shutdown windows.
 Include files
 -------------
 
 Include files
 -------------
 

-The whitepaper says to include mkws-complete.js. This file is made by concatenating
+The manual says to include mkws-complete.js. This file is made by concatenating

 a number of files (see Makefile). For us developers, it is easier to include the
 raw files, as in
 
 a number of files (see Makefile). For us developers, it is easier to include the
 raw files, as in
 

@@ -54,9 +74,18 @@ Most (all?) code work happens in mkws.js.
 Unit tests
 ----------
 
 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
 
 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
 --------------------
 
 Structure of mkws.js
 --------------------