This file is cipres/framework/etc/build_scripts/WindowsBuildInstructions.txt

=======================================================================
BUILDING CIPRES ON WINDOWS
=======================================================================

PREREQUISITES:
	You need
		- Microsoft Visual Studio .NET 2003
		- Python 2.4
		- Ant 1.6.5
		- A subversion client (svn)
		- Java 1.4x
		- JUnit3.8.1 (copy the junit.jar to %ANT_HOME%\lib\)

	To run Cipres you'll also need to have Paup installed. A cipres bug 
	requires that paup be installed in a directory that doesn't have any
	spaces (eg. c:\Program Files\paupWin32 won't work!).  


INITIAL BUILD:
1.	Download winCIPRES_src.zip and extract the contents. This will create a directory
	named winCIPRES.

2. Set required environment variables:

	- Python24 (or later), Ant 1.6.5 (or later), java and svn must be
	in your PATH.

	- Open a command prompt window and run

		C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\Tools\vsvars32.bat

	to set environment variables that allow you to run visual studio from the
	command line (devenv.exe).

3. In the command prompt window run makeCIPRES.bat.

	MakeCIPRES.bat uses svn to check out the latest CIPRES code from the SDSC
	repository, then runs build_cipres.py to build cipres.  If prompted for
	an svn login you can use the read only guest account (username=guest, 
	password=guest) or your own account if you have one.

	build_cipres.py will prompt you to enter your username for a cvs account
	at FSU.  If you don't have an account you can enter anything and hit return.
	The build will still work.

SUBSEQUENT PARTIAL BUILDS:
	When the initial build is complete it prints out a list of variables that
	you need to set if you want to rebuild parts of cipres without using
	build_cipres.py. For instance, you may want to use Visual Studio
	interactively to build the C++ components and you may want to use ant
	or eclipse to build the java components.


RUNNING THE CIPRES APPLICATION:
	To run Cipres, double click c:\winCIPRES\CIPRES-0.0.1\cipres\cipres.jar
	or run "java -jar c:\winCIPRES\CIPRES-0.0.1\cipres\cipres.jar".  The latter
	method will dump a lot of debugging information to the terminal. 

RUNNING ANT/JUNIT TESTS:
	These require a junit jar in the %ANT_HOME%\lib.  You can copy
	c:\winCIPRES\CIPRES-0.0.1\cipres\cipres_dist\lib\junit\jars\junit-3.8.1 to
	%ANT_HOME%\lib.  Then, from c:\winCIPRES\CIPRES-0.0.1\cipres, run "ant junit-test"

	Don't interact with the gui the tests present, let it do its own thing.  Use
	a browser to view the test result report in cipres\cipresapp\java\test\results
	(results directory will be changed in the near future so don't be surprised to
	find this info out of date.)


BUGS AND PROBLEMS:
	Mail to terri@sdsc.edu and/or mholder@csit.fsu.edu.

ADDITIONAL INFORMATION

	Consult http://cipres.sdsc.edu/twiki/bin/viewauth/Cipresdev/BuildCipresPyScript
	for a full description of the build system.