From 22364d2708dc777d2c336dbfc1635fa895b04799 Mon Sep 17 00:00:00 2001
From: Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
Date: Wed, 16 Jul 2014 09:34:04 +0000
Subject: [PATCH] updated docs

git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@161 8ec27952-4edc-4aab-86aa-e87bb2611832
---
 documentation/Mainpage.md     | 59 +++++++++++++----------------------
 documentation/Server.md       | 37 +++++++++++++++++++++-
 documentation/clients/OPAL.md | 14 +++++----
 3 files changed, 66 insertions(+), 44 deletions(-)

diff --git a/documentation/Mainpage.md b/documentation/Mainpage.md
index 773c834e9..cc46db98d 100644
--- a/documentation/Mainpage.md
+++ b/documentation/Mainpage.md
@@ -1,6 +1,26 @@
-S2SS is a client server application based on UDP/IP to connect simulation equipment.
+S2SS is a client/server application based on UDP/IP to connect simulation equipment/software such as:
 
-It's designed with focus on low latency to establish soft-realtime communication.
+ - OPAL-RT,
+ - RTDS,
+ - Simulink,
+ - LabView,
+ - custom made equipment,
+ - and FPGA models.
+
+It's designed with focus on very low latency to achieve almost realtime communication.
+S2SS is used in distributed- and co-simulation scenarios and developed for the field of power grid simulation at the EON Energy Research Centre in Aachen, Germany.
+
+## Overview
+
+The project consists of a server and several client applications.
+Both server-to-server and direct client-to-client communication is possible.
+All communication links use the same message protocol to exchange their measurement values.
+
+### Server
+
+For optimal performance the server is implemented in lowlevel C and makes use of several Linux-specific realtime features.
+
+### Clients
 
 ## Contact
 
@@ -9,39 +29,4 @@ This project is developed at the [Institute for Automation of Complex Power Syst
  - Steffen Vogel <StVogel@eonerc.rwth-aachen.de>
  - Marija Stevic <MStevic@eonerc.rwth-aachen.de>
 
-## Compilation
-
-Install libraries including developement headers for:
-
- - libconfig
-
-Start the compilation with:
-
-	$ make
-
-Add `V=5` for a more verbose debugging output.
-
-## Installation
-
-Install the server by executing:
-
-	$ sudo make install
-
-Add `PREFIX=/usr/local/` to specify a non-standard installation destination.
-
-**Important:** Please note that the server requires the
-[iproute2](http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2)
-tools to setup the network emulation and interfaces.
-
-Install these via:
-
-	$ sudo yum install iproute2
-or:
-
-	$ sudo apt-get install iproute2
-
-## Configuration
-
-See [configuration](Configuration.md) for more information.
-
 
diff --git a/documentation/Server.md b/documentation/Server.md
index 72d9edc40..ced3ae98b 100644
--- a/documentation/Server.md
+++ b/documentation/Server.md
@@ -1,7 +1,42 @@
-# Server {#server}
+# Server
 
 @subpage configuration
 @subpage usage
 @subpage netem
 
+## Compilation
+
+Install libraries including developement headers for:
+
+ - libconfig
+
+Start the compilation with:
+
+	$ make
+
+Add `V=5` for a more verbose debugging output.
+
+## Installation
+
+Install the server by executing:
+
+	$ sudo make install
+
+Add `PREFIX=/usr/local/` to specify a non-standard installation destination.
+
+**Important:** Please note that the server requires the
+[iproute2](http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2)
+tools to setup the network emulation and interfaces.
+
+Install these via:
+
+	$ sudo yum install iproute2
+or:
+
+	$ sudo apt-get install iproute2
+
+## Configuration
+
+See [configuration](Configuration.md) for more information.
+
 @todo Move documentation from Mainpage to Server.
diff --git a/documentation/clients/OPAL.md b/documentation/clients/OPAL.md
index d002c4430..bd78c0234 100644
--- a/documentation/clients/OPAL.md
+++ b/documentation/clients/OPAL.md
@@ -2,17 +2,19 @@
 
 @defgroup opal OPAL-RT
 
-The communication between OPAL-RT models and the S2SS is established by using ansychronus programs.
-Asynchronous programs are a feature of RT-LAB.
+The communication between OPAL-RT models and the S2SS is established by using ansychronous programs.
+Asynchronous programs are are a feature of RT-LAB. They are used to exchange data between Simulink models and custom C programs.
 
-## Source Code
+For this purpose the C program handels IP/UDP communication via BSD sockets.
 
-The source code of the asynchronus program is located at:
-
-	/clients/opal/models/AsyncIP_sl/s2ss/
 
 ## Arguments for OPAL-RT block
 
+RT-LAB already provides a block to establish simple TCP/IP communication: ???
+This block is based on a more generic block used for aynchronous programs: ???
+
+@todo Insert name of RT-LAB blocks.
+
 | Param		 | Description   | Example Value  |
 | :------------- | :------------ |:-------------- |
 | FloatParam[0]	 | Protocol      |                |