update readme

[frescor/fna.git] / README

diff --git a/README b/README
index 1982d217a1d6e3cdff1c3b42706b02ee8776551b..8b76ec525845ed3eb3e6f8395345196532c39455 100644 (file)
--- a/README
+++ b/README
@@ -1,22 +1,48 @@
-Introduction
-============
+FNA
+=====================
+Name:
+FNA
 
-This is the development trunk of FNA (Frescor Network Adaptation layer), the
-layer that allows to plug-in different network protocols to FRESCOR by means
-of a clear interface.
+Version:
+May 2008
 
-Directory Overview
-==================
+Status:
+Alpha
 
-- README: This file.
+Authors:
+Daniel Sangorrin [daniel.sangorrin@unican.es] (UC),
+Michael Gonzalez Harbour [mgh@unican.es] (UC)
+Martin Molnar (CTU)
+Michal Sojka (CTU)
 
-- COPYING: GNU GENERAL PUBLIC LICENSE
+Licence:
+FRESCOR Lincece (see COPYING)
 
-- include/: FNA API C header files.
+Brief description:
+This is FNA (Frescor Network Adaptation layer) module, the layer that allows
+to plug-in different network protocols to FRESCOR by means of a clear interface.
 
-- src/ : source code of FNA that is common to all protocols
+URL:
+svn co http://www.frescor.org/private/svn/frescor/fna/trunk/
+
+Bugs:
+See TODO
+
+Description:
+
+This is FNA (Frescor Network Adaptation layer) module, the layer that allows
+to plug-in different network protocols to FRESCOR by means of a clear interface.
 
-- doc/: Documentation (TODO, INSTALL, changelog and API_reference.pdf)
+- README: This file
 
+- COPYING: FRESCOR license
+
+- INSTALL: Installation instructions
+
+- include/: FNA API C header files.
+
+- src/ : source code of FNA that is common to all protocols
 
+- src_xxx/ : source code of 'xxx' protocols
 
+- doc/: documentation directory