Read Me

MighTyD - A database management system based upon Hugh Darwen, C.J. Date
and Nikos Lorentzos' Tutorial D with temporal extensions
Copyright (C) 2006 Rachel Bowers, Adrian Hudnott, Sergey Petrov, Thomas Pick, Issam Souilah

This program is free software; you can redistribute it and/or modify
it under the terms of the Cokefolk Public License, Version 1 as published
by Rachel Bowers, Adrian Hudnott, Sergey Petrov, Thomas Pick and
Issam Souilah. A copy of the license is included in the section entitled
"Cokefolk Public License".

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
file LICENCE.txt for more details.

Installation
------------
The database connectivity layer in the current release integrates with a PostgreSQL server
back-end. Therefore, before you can use this software with database integration you must
first install and configure a PostgreSQL server, instructions for which can be found at
http://www.postgresql.org/ftp/.  Alternatively, the software will function without
integration with a PostgreSQL back-end, although database functionality will not then be
supported.

The software creates some files at runtime and therefore cannot be run directly from the
CD-ROM.  You will need to copy the contents of the /jars directory to hard disk.

Database Requirements
---------------------
When running MighTyD, you must supply a username and password that are valid to access
your PostgreSQL server if you wish to use database functionality. Furthermore, there must
exist a database of the same name as the username which you provide. This name should NOT
be 'admin'.

Running the Software
--------------------
The software is client/server based.  Both the client and the server have graphical and
console user interfaces.  To start the server using the graphical user interface
double-click on "MighTyD_Server.jar".  Alternatively, to start the server using the
command-line interface run the shell script "mightydserver" or "MighTyDServer.bat" as
appropriate for your operating system. Then, to start the graphical client double-click on
"MighTyD_Client.jar".  Alternatively to use the command-line interface run the shell script
"mightyd" or "MighTyD.bat" as appropriate for your operating system.  Ensure that your
firewall has port numbers 1235 and 5432 freely accessible by the local machine.

If your graphical interface does not executing JAR files with a double-click then the
following command-lines can be used instead:
cd jars
java -jar MighTyD_Server.jar
java -jar MighTyD_Client.jar

Login Details
-------------
One account, with username "admin" and password "password" is created the first time the
server is run. This account has administrative privileges within the system. As an
administrator you may execute SQL via the SQL option on the toolbar.

Other users may register with the system using the Register button in the Login dialogue.
Any registered user is given their own area in the underlying database and can therefore
store and retrieve their personal tables. They can also create a sample database in their area. 

Further Information
-------------------
A complete user manual is available, either by clicking the Help button on the toolbar or as
Appendix E of the group report.  Supplementary information is available on the project website
at http://www.dcs.warwick.ac.uk/~cokefolk.

Points of Information
---------------------
. Relation and attribute names are case sensitive.
. If you need to refer to a relation attribute that contains a Tutorial D keyword or a space
then enclose it in backticks (`relation`).
. A database catalog relvar "Catalog" is available to aid familiarisation with the sample
database.