Read Me

>>> COURSE >>>

Process Oriented Programming (1DT083) Spring 2011


>>> GROUP >>>

10


>>> PROJECT NAME >>>

Uratool


>>> PROJECT DESCRIPTION >>>

A collaborative coding editor that uses a central server for updateing.


>>> GROUP MEMBERS >>>

900520-2339 Tomas.Savstrom.7943@student.uu.se
890904-6180 Kristiina.Ausmees.6498@student.uu.se
900302-3778 Jens.Rosen.3447@student.uu.se
850726-0373 Joakim.Lindqvist.7537@student.uu.se
901231-1016 Lukas.Klingsbo.8671@student.uu.se
751019-4876 Joakim.Hansson.8957@student.uu.se


>>> MAY THE SOURCE BE WITH YOU >>>

Everything you need to compile and run the system is included in this
directory. 

However, you might want to get the most up to date version of this
directory. 

If you are running a operating system with SVN in the terminal the commando:
svn co https://uratool.svn.sourceforge.net/svnroot/uratool uratool

will create a map that is connected to where you can find the latest version, 
then you simply run the commando:
svn update

while in the created directory to get the latest version.


>>> DIRECTORY CONTENTS >>>

.
├── Makefile 
├── README.txt (the file you are reading right now).
├── doc/
│   ├── final_presentation.pdf
│   ├── final_report.pdf
│   └── html/ (all files generated by Edoc)
├── ebin/ (beam files)
├── files/ (text files)
├── include/ (record and macro definitions in .hrl files)
└── src/ (Erlang source files) 
	└── images/ (images for the gui)

>>> ERLANG VERSION >>>

This code has been developed and tested using Erlang version R14.

>>> MAKE IT HAPPEN >>>

Using the make utility you can perform the following actions:

make         ==> Compiles the Erlang source files if necessary. 
make archive ==> Creates a gziped tar archive of this directory. 
make clean   ==> Removes all beam files and html files generated by Edoc.
make doc     ==> Generates Edoc documentation in the doc/html directory.
make start   ==> Starts the system.
make test    ==> Runs all Eunit tests.


>>> TO COMPILE >>>

To compile the project, simply type make and press enter.


>>> TO RUN AND TEST THE SYSTEM >>>

To begin with start up atleast 3 terminal windows, then take on of these and write the commando:
erl -sname server -setcookie abc

This will start up erlang and the last line of the terminal should look like:
server@hostname 1>

Now you write the commando:
auth_server:start().

To start the server.

You then go to one of the two remaining terminals where you give the commando:
erl -sname client1 -setcookie abc

This will start up erlang and the last line of the terminal should look like:
client1@hostname 1>

Then write the commando:
client:start("erlang.txt",'server@hostname').

Where erlang.txt is the file to be edited.

Now go to the second terminal and do the same thing expect you change client1 
to client2 in the command. You now have a running server and two clients connected to the same file. 
The same thing works if you have more then one computer and start the server and clients on different 
computers as long as these computers are on the same network. For a more detailed description have a look
at final_presentation.pdf.