-================= Autshumato TMS =================-

/*
*  Autshumato Terminology Management System (TMS)
*  Free web application for the management of multilingual terminology databases (termbanks). 
*
*  Copyright (C) 2014 Centre for Text Technology (CTexT®), North-West University
*  and Department of Arts and Culture, Government of South Africa
*  Home page: http://www.nwu.co.za/ctext
*  Project page: http://autshumatotms.sourceforge.net
*   
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*/

Autshumato Terminology Management Solution (TMS) is a free web application for the management of multilingual terminology databases (termbanks).

Version: 2.0.0
Platform: The application is web based and in essence platform independent. It is however recommended that the application be accessed using the latest version of the Mozilla Firefox browser or Google Chrome.
License: Apache License version 2.0
The license is contained in the "APACHE LICENSE-2.0.txt" document. The components used and equivalent licenses are listed in the "TMS Components & Licenses.txt" document. 
The licenses for the various components are also available in the "/documentation/Licenses/" directory.

Project page: http://sourceforge.net/projects/autshumatotms
Developer: Centre for Text Technology (CTexT®) at the North-West University (Potchefstroom Campus)
Documentation:
Readme: This document
Server Setup: /documentation/TMS Server Setup.odt
Help Guide: /source/war/Help/index.html
Components & Licenses: /source/TMS Components & Licenses.txt
License: source/APACHE LICENSE-2.0.txt
Component Licenses: /documentation/Licenses/
Scripts: /documentation/Perl Scripts
war: binaries/tms.war
images: /images


The complete source code and binaries can be downloaded from the project page. The project page also allows users to notify the project team of bugs and submit feature requests. Check it regularly for the latest distribution.

-=== Build ===-
To build the application from the source code the following components are required:
- Eclipse IDE
	Although the application was created using Eclipse most IDEs should be able to build the application if all the requirements are met.
- PostgreSQL 8.4 (or later)
	The database for the system is a PostgreSQL database.
	This can be downloaded from: http://www.postgresql.org/
- Google Web Toolkit SDK 2.5.1 or later
	This can be downloaded from: http://code.google.com/webtoolkit/
	Complete installation instructions can also be found at the abovementioned website.

Download and install Eclipse or the IDE of your choice. 

Go to the Google Web Toolkit (GWT) website (http://code.google.com/webtoolkit/), download and install the GWT SDK and all relevant plugins. Detailed steps on how this is done are available on the website. 

Download and extract the Autshumato TMS source code from the project page: http://sourceforge.net/projects/autshumatotms

Please refer to the server setup document (documentation/TMS Server Setup.odt) to create and install the TMS 2.0.0 database

If you have any questions or problems post a message on the project page.


-=== Run ===-
- The application must have been set up on a server with the database and configuration files properly implemented. This procedure is available in the "/documentation/TMS Server Setup.odt.
- Internet browser
	We recommend using the latest Mozilla Firefox or Google Chrome browser.
- Address to the application hosted on a server.
	You should be provided with the address of the application on a server from the person responsible for installing the application.


-=== Using the Application ===-
For a complete guide on using the Autshumato TMS refer to the Help documentation, which can be found in the /source/war/Help/ directory. The Help guide is also be available through the application.

The system can be accessed by anyone but without a valid user account you will have limited functionality. A signed-on user will enjoy most of the functionality determined by the access rights of the specific user or user category to which the user belongs.

The administrator of the system is responsible for creating users, user categories, fields and pre-sets, as well as the assigning of access rights.


-=== Questions, Errors, etc. ===-
Kindly post any questions or bug reports on the project page.
