Read Me

README
======

KERL is a library and driver to allow robot control using Player from Erlang functional Language.  Please refer to INSTALL for detailed guidelines.

PRE INSTALLATION
================

KERL requires the following to function
	- libplayerc
	- ei

BUILDING
========

run 'make' to build KERL driver and modules. 

INSTALLATION
============


Installation is not currently supported yet.
Please refer to ./INSTALL


DOCUMENTATION
=============

You can generate the edoc and doxygen documentation by

# cd ./doc/
# make

This will produce html files with the documentation for KERL's source files.


TESTING
=======

You must first build KERL before you can test it.

Run 'make test' to test all code.
Rhis can also be done in any folder inside testing.

Try the examples found in the example folder by running
player with the worlds provided in worlds folder.


DIRECTORY STRUCTURE
===================

doc				- Source Documentation
ebin			- Erlang compiled modules
examples	  	- Example erlang programs
include 	  	- Include files
kerlplayerlib 	- Player driver library
module 			- Module source code
testing			- Unit testing
worlds			- Player world configurations for testing


AUTHORS
=======

Thomas Lorentsen
Sten Gruner