*******************************************************************************
*                            JControl/IDE - Readme                            *
*******************************************************************************

#######################################
===            Contents             ===
#######################################

I. JControl/IDE Start
II. JControl/IDE Configuration
III. Hello World - Project
IV. Tools and file types
V. Simulation
VI. Documentation

If you found a bug, please report it on our forum at
http://jcontrol.org/forum/ or write a mail to bugs@jcontrol.org.

#######################################
===      I. JControl/IDE Start      ===
#######################################

a) To start the JControl/IDE, just single or double click the icon found on
   the desktop or in the start menu. If you don't have any of these shortcuts,
   please go into the installation directory to the bin folder and start
   the IDE executable ('*.exe' for Windows or shell script for Linux).

b) Alternatively, you may also start the JControl/IDE directly by invoking
   a Java Runtime Environment by command line (Version 1.5 or later).

   For Windows environemtns, please enter
     javaw -Djava.ext.dirs=".\lib\shared;.\lib\win32" -Djava.library.path=".\lib\win32\native" -jar plugins\IDE\IDE.jar

   For Linux environments, please enter
     javaw -Djava.ext.dirs="./lib/shared:./lib/linux" -Djava.library.path="./lib/linux/native" -jar plugins/IDE/IDE.jar


#######################################
=== II. JControl/IDE Configuration  ===
#######################################

a) The JControl/IDE will load all libraries and files it needs to run.
   It will also launch an auto configuration. If the configuration fails, a
   user input is required and a configuration dialog will appear.
   Read section c) and d) of this chapter for more details.

b) The first time you start the JControl/IDE, it will open the "Project Open
   Wizard", because there are no opened projects yet. Select an option or
   simply close the dialog by clicking on the "X" button on the right top
   of the dialog window.

c) If you want to change the paths used by the JControl/IDE, please navigate
   to the menu "Extras/Other Settings...". Ensure that you're on the
   path-settings page in the new dialog. On this page you can configure all the
   pathes the JControl/IDE needs to run properly. Set the user-settings to your
   desired values. The standard values for the system-pathes are:
   - main path = the installation path of JControl
   - project templates = <main path>\templates
   - device libraries = <main path>\profiles\jar
   - device profiles = <main path>\profiles\xml
   - device icons = <main path>\profiles\icons
   - plugins = <main path>\plugins

   Close the dialog window by pressing the "Ok" button.

d) If you wand to change the registry key of the JControl/IDE, please navigate
   to the menu "Extras/Registry Keys" and ensure, that the list contains at
   least one key. If this is not the case, press the "Add" button and navigate
   to the installation directory of JControl. Go to the keys folder, select
   e.g. the file "standard.key", and confirm the open-dialog.

   The keys are required to enable some features of the JControl/IDE. Some
   features are still under development and will require a newer edition of
   JControl/IDE. The edition you've received in this pakage is the standard
   edition and it may be updated in the future releases.

   Close the dialog window by pressing the "Ok" button.


#######################################
===   III. Hello World - Project    ===
#######################################

a) To start the JControl/IDE, just single or double click the icon found on
   the desktop or in the start menu. If you don't have any of these shortcuts,
   please go into the installation directory to the bin folder and start
   the IDE executable.

   The JControl/IDE will load all libraries and files it needs to run.
   It will also launch an auto configuration. If the configuration fails, a
   user input is required and a configuration dialog will appear.
   Read section I.c) and I.d) for more details.

b) The first time you start the JControl/IDE, it will open the "Project Open
   Wizard", because there are no opened projects yet. Select the
   "Open Project" button.
   You may also navigate to the menu "Project/Open" of the JControl/IDE to
   open a project.

c) On the open-dialog navigate to the install directory of the JControl. Then
   go to the "demos/smartdisplay/app/HelloWorld" folder and select the
   "HelloWorld.jcp" project file. Confirm the open-dialog by pressing the open-
   button. The HelloWorld-project will be loaded and the last editors will be
   opened.

d) Open the HelloWorld project by clicking "HelloWorld" on the left-top of the
   JControl/IDE.

e) Press the "Start Simulator" button on the toolbar on the top of the
   JControl/IDE (the small computer icon with the round green arrow).

f) The simulator will be started. You will see a "JControl/SmartDisplay"
   running the Hello World program on its display.

   In the same way you can open and test all the other demos & examples.


#######################################
===    IV. Tools and File Types     ===
#######################################

When installing the JControl/IDE, the installer will also install the JControl
resource editors for creating and editing of the JControl files. The stand-
alone versions of these tools are located in the bin directory of the JControl
installation path. The editors are also integrated into the JControl/IDE.

For windows systems, all editable file types can be registered with the
operating system. This is done by the last dialog of the installer.
The following file types can be registered:
- .jcp  - JControl/Project file
- .jcfd - JControl/FontDefinition file
- .jcif - JControl/ImageFile file
- .imy  - JControl/MelodyFile file

The files of this types can easily be opend by single/double-clicking in the
system explorer of the operating system. This starts the right editor and
loads the file into it.


#######################################
===          V. Simulation          ===
#######################################

To simulate a project, please start the simulator by pressing the button with the
white arrow in the green circle. The simulation will be started in the editor's 
window of the project.

Please note: An IP port will be used by the simulator to perform the I/O traffic
between the simulated device and the simulation desktop. This port is only used
to transfer data between two processes running on THE SAME machine, and it will
not be used to send messages to other PCs.

If you are using a firewall, you may have to authorize the Java Virtual Machine 
the connect to the IP network.


#######################################
===        VI. Documentation        ===
#######################################

If you install the JControl/IDE, you optionaly can install additional
documentation. After installation, the documentation is located at the docs
directory of the installation path.


For more information, please visit us at http://jcontrol.org/documentation.
*******************************************************************************

DOMOLOGIC GmbH
Rebenring 33
D-38106 Braunschweig
Tel.: +49-(0)531-3804-340
Fax: +49-(0)531-3804-342
e-Mail: info@domologic.de
