DESCRIPTION:
============

Cyclotis is a database enabling to translators to work at same time on the same document.
This is not a full computer-assisted-translation (CAT) tool,
but a resource to be plugged into your favorite CAT client interface.

This package contains a REST/XML interface for users to create/delete memories.

INSTALLATION:
=============

This is written using Perl framework named 'Dancer'. Look at http://www.perldancer.org/
and install Dancer library, with Database plugin, Perl-DBI and Perl-DBD::Pg 
Users of debian can install the package libdancer-perl, which will check for dependancies.

It also requires SQL creation scripts from Cyclotis project (http://www.silvestris-lab.org/node/18)

USAGE:
======

First you must configure the application using config.yml
As the three given samples show you, the application is totally agnostic about the meaning of $ variables:
choose whatever you want depending on your organisation.

Once installed, run web-creator-rest.pl on a server. Perl/Dancer includes a web server which listens on given port
(default 3000, unless you run it via any alternate server, such as Starman)
You can change the port via '-p' parameter.

Then use it as a REST web service: you can use a test tool like SoapUI. 
Finally this interface is not for users, but to make possible for developers of workflow tools
to make the integration of Cyclotis database with their own GUI.

LICENSE:
========

Please read the file LICENSE for the very last version of conditions applied to this code.

