		TANGO classes source code release - README
		------------------------------------------
		
		
			  Serial Line Class - Version 1.0
			  ===============================
			
			    Jens Meyer (meyer@esrf.fr)
			           07/08/2007


TABLE OF CONTENTS
-----------------

 1 - Introduction
 2 - What's inside
 3 - Prerequisites
 4 - Configuration
 5 - Compilation
 6 - Running
 7 - Documentation
 8 - Remarks
 9 - Questions
10 - URL


1 - INTRODUCTION
----------------
This is the README for the TANGO classes source code release.
 
TANGO is a toolkit for building object oriented control systems 
based on CORBA. TANGO is a joint effort of the ESRF, ELETTRA, 
ALBA and SOLEIL synchrotron radiation sources.

The TANGO classes source code release allows to add Tango classes one by
one to your Tango system. After installation and compilation, the class
can be used as standalone Tango device server or can be added to any
new device server by editing the ClassFactory.cpp file and linking with
the created archive or shared library for the installed class.

The package is intended for Windows platforms. The source code contained 
in this package also run under Unix but the Visual Studio project don't. 
Check for a special Unix release for the class.


2 - WHAT'S INSIDE
-----------------
This source code release contains all necessary source files for a Tango 
class to build an executable device server and an archive and shared library
for the class.
For Windows it contains also a precompiled version of all class libraries
and server executables for Windows 32 bits.
Documentation is provided as an html file with pointers to the centralized 
classes documentation.


3 - PREREQUISITES
-----------------

Before compiling and installing a Tango class you need to install :
	 
(1) Tango for Windows, available from http://www.tango-controls.org/download 
	 (version >= 5.0)

Also check the tools you are using

(2) The contained project file is for Visual Studio 2005 (VC8) or with 
    the free version VisualC++ 2005 Express Edition.


4 - CONFIGURATION
-----------------

Once you have installed the packages in prerequisites you can think
about compiling Tango classes.
To compile your Tango class package you need to tell it where to find 
omniORB and Tango include files and libraries.

You have to define the environment variable TANGO_ROOT to the base
directory of your Tango installation.


5 - COMPILATION
---------------

Go to the source directory of the downloaded class package.
Here you will find a subdirectory win32_vc8 which contains
the project file to build the class.

Open the xxx.sln file with Visual Studio 2005 or its Express Edition.
Choose whether you want to build a debug or a release version.
On the menu bar go to build and choose build solution.
This should create an archive library, a DLL, a statically linked 
executable and a dynamically linked executable.
The output directory is set to the package installation directory
xxx/classes/win32_vc8.

The directory classes/win32_vc8 already 
contains a precompiled version of all class libraries
and server executables for Windows 32 bits.
The archive version should run without problems. The dynamic
(DLL) version might not be compatible with the installed Tango
version.

After a successful compilation you might want to install the include
files, class libraries and executable for further use under:
		$TANGO_ROOT/classes/win32_vc8
Two scritps are delivered with the package to install a static or a dynamic
version of the class.
		install_static.bat and install_dynamic.bat		


6 - RUNNING
-----------
To run the compiled Tango device server and to configure its properties
you should use the Tango configuration wizard available with Jive and
Astor.

(1) Jive:
    Start Jive and go to the Tools menu and start the "Server Wizard".
	 Just follow the instructions or have a look to
	 
	 http://www.esrf.eu/computing/cs/tango/tango_doc/tools_doc/astor_doc/movies/wizard.html
	 
	 before using the wizard.
	 In this case you will be asked to start your Tango server manually.
	 Your server will start-up empty (without any device defined!) and
	 will restart with the new configuration when the configuration 
	 with the wizard is finished.
	 
(2) Astor:
	 When using the Tango Starter server and Astor to administer your Tango 
	 system you can use the configuration wizard from Astor.
	 See the Astor documentation from 
	 
	 http://www.tango-controls.org/tools
	 
	 and the chapter "Start a New Server".
	 

7 - DOCUMENTATION
-----------------

All necessary references are available from the html documentation file
delivered with this package (doc/TangoClassesDocumentation.html).

Don't forget to check the Tango manual installed the the
Tango package ( $TANGO_ROOT/doc/tango_x.x.pdf).


8 - REMARKS
-----------
In the case of dependencies of this class to abstract classes or other
Tango classes you need to download the necessary classes first. 
The should be installed in $TANGO_ROOT/classes/win32_vc8 to let
the project file find them automatically.
Otherwise you need to change the project file to indicate your 
installation pathes.


9 - QUESTIONS
-------------

In the case of problems of further questions, send a mail to the Tango
mailing list (tango@esrf.fr). See the html documentation delivered with 
this package to find how to subscibe to the mailing list.


10 - URL
--------
See the html documentation delivered with this package to find
all necessary references.

Or visit directly the TANGO website http://www.tango-controls.org for online 
documentation, news and to download add-on packages.
