#
# $RCSfile: README.txt,v $
#
# Copyright (c) 1999-2002. The Res Medicinae developers. All rights reserved.
#
# This software is published under the GPL GNU General Public License.
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
# http://www.resmedicinae.org
# - Information in Medicine -
#
# This file gives first informations about Res Medicinae. 
#
# @version $Revision: 1.5 $ $Date: 2002/10/02 19:48:54 $ $Author: chrissy $
# @author Michael Simon <michael.simon@gmx.net>
# @author Henrik Brandes <henrik-b@gmx.de>
# @author Christian Heller <christian.heller@tuxtax.de>
#


Contents
________

1 Introduction
2 Documentation
3 Installation
4 Use
5 Build
6 Directories


1 Introduction
______________

"Res Medicinae" is ancient Latin language and means something like
"Matter of Medicine".

We want to make it a comprising solution for Healthcare IT. It's a big
effort and we are working on that matter for some years now. We will
probably still need a longer time until we can offer a really functioning,
complete system. However, a start has been made.

Nevertheless, we hope you enjoy our software right now!
Feel free to give us feedback, comments, critics, new ideas to:
resmedicinae-developers@lists.sourceforge.net

The Res Medicinae developers


2 Documentation
_______________

Our complete website is integrated into the downloaded file.
Check it out to find manuals, user and developer documentation!
Just open the index.html file in the root directory of the project!


3 Installation
______________

- JAVA is required to install and run Resmedicinae
- change to the folder you downloaded resmedicinae_0.0.4.0.jar to
- enter the following command: "java -jar resmedicinae_0.0.4.0.jar"
- follow the instructions on the screen

- uninstall Resmedicinae:
- change to Resmedicinaes' subdirectory "/uninstaller"
- enter the following command: "java -jar uninstaller.jar"


4 Use
_____

1 Open a terminal/console window (DOS box in Windows)

2 Change to the Res Medicinae project directory, e.g. /home/resmedicinae

There is main (e.g. ResMedPortal) and child (e.g. Record) applications.
When having started a main application, you will have the possibility to run
any child applications from within the main application. Notice that we are
still experiencing problems providing the full functionallity of the children
when they are run from within the main application. In order to run them with
their full functionallity, you have to run the child applications just on their own,
as a standalone application which is completely independent from any main application.

3 Execute the appropriate script to run the application, e.g.:

- to run the main application:

./bin/startup_main.sh (under Linux)

or

\bin\startup_main.bat (under Windows)

- to run the child applications:

./bin/startup_record.sh (under Linux) or \bin\startup_record.bat (under Windows)
./bin/startup_reform.sh (under Linux) or \bin\startup_reform.bat (under Windows)
./bin/startup_restore.sh (under Linux) or \bin\startup_restore bat (under Windows)


5 Build
_______

1 Open a terminal/console window (DOS box in Windows)

2 Change to the Res Medicinae project directory, e.g. /home/resmedicinae

3 Execute the appropriate script to build the project, e.g.:

./bin/build.sh compile (under Linux)

or

\bin\build.bat (under Windows)


6 Directories
_____________

/resmedicinae
    /admin  - project administration information, developers, workgroups,
              mailing lists
    /bin    - several launch and compile scripts for different operating systems
    /build  - temporary directory that is created on system build and can always
              be deleted without trouble
    /dist   - temporary directory that is created on system release/distribution
              build and can always be deleted without trouble
    /doc    - various documentation
    /etc    - configuration files
    /lib    - java archive files/libraries
    /local  - local configuration files
    /model  - developer information for analysis, design, implementation,
              project plan
    /share  - files which can be shared between the single applications/systems,
              such as icons, images, sounds, forms etc.
    /src    - source code
    /tmp    - temporary files, testing stuff
    /tools  - external tools


