diff m-toolbox/INSTALL.txt @ 0:f0afece42f48

Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/INSTALL.txt	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,50 @@
+Various instructions for developers
+-----------------------------------
+
+This describes how to take the source of the ltpda toolbox and make a toolbox
+for a particular platform. Also some instruction on development.
+
+Installation
+------------
+
+In a terminal:
+
+1) Check-out a fresh copy of the source tree
+    
+  > cvs co -P ltpda
+
+In MATLAB:
+
+2) cd ltpda/software/m-toolbox
+
+3) Edit makeToolbox.m and change the options in the Settings section at the top.
+   The rootdir should be set to the place you want the final, usable toolbox to 
+   be installed, for example, 
+
+   rootdir = '/home/hewitson/matlab/';
+
+   Set:
+
+   compile_mex = 1
+
+   if you want to compile the mex files as well (you probably do).
+
+   Make sure you have deleted any old version of a compiled toolbox from rootdir
+   before going on. (This is not necessary if the old version is in the same place
+   as the new one.)
+
+4) run the script (hit F5 or type makeToolbox in the MATLAB terminal).
+
+5) Add the command 'ltpda_startup' to the end of your startup.m
+
+6) You should now be able to run the various test scripts
+   
+   >> cd ltpda/software/m-toolbox/test
+
+   Note: these test scripts use the functions and classes of the newly 
+   installed toolbox, NOT those in the source tree.
+
+
+Making changes to the source
+----------------------------
+