README for the eric3 IDE
========================

1. Remote Debugger
------------------
In order to enable the remote debugger start eric3, open the preferences
dialog and configure the settings on the debugger tab.

The remote login must be possible without any further interaction (i.e.
no password prompt). In addition to this, the environment must be the same 
as on the local machine, which is the python interpreter must be in the
same path, PyQt must be installed and all the python source of the debugged
program must be accessible in the same path.

Please be aware, that this is experimental and not thoroughly tested. Please
report back to <detlev@die-offenbachs.de>

2. Installation
---------------
Installing eric3 is a simple process. Just execute the install.py script
(type python install.py -h for some help). Please note that the installation
has to be performed using the administrators account (i.e. root on linux). 
This installs a wrapper script in the standard executable directory 
(default: /usr/local/bin on linux) called eric3.

If you want to uninstall the package just execute the uninstall script. This 
gets rid of all installed files. In this case please send an email to the
below mentioned address and tell me your reason. This might give me hints on
how to improve eric3.

3. Running
----------
Just call up eric3, which will start the IDE. Use the "what is"-help
(arrow with ?) to get some help. Sorry, there is no documentation yet.
To start the unit test module in a standalone variant simply call up 
qtunittest. This will show the same dialog (though with a little bit less
functionality) as if started from within eric3. The helpviewer can be
started as a standalone program by executing the helpviewer script.

4. Internationalization
-----------------------
eric3, qtunittest and helpviewer are prepared to show the UI in different
languages which can be configured via the preferences dialog. The Qt and
QScintilla translations are searched in $QTDIR/translations first, then in
the eric3 installation directory and finally in the current directory.
Please ensure, that the translations (.qm files) are somewhere in this
path. Most Qt installations don't install them by default. If this is
the case, some part of the MMI might show English texts even if you have
selected something else. If you are missing eric3 translations
for your language and are willing to volunteer for this work please send
me an email naming the country code and I will send you the respective 
Qt-Linguist file.

5. License
----------
eric3 (and the others) is released under the conditions of the GPL. See 
separate license file for more details.

6. Bugs and other reports
-------------------------
Please send bug reports, feature requests or contributions to eric-bugs address.
<eric-bugs@die-offenbachs.de>
