[Lada-commits] [PATCH 4 of 4] Added README file

[Wald Commits]

# HG changeset patch
# User Raimund Renkert <raimund.renkert at intevation.de>
# Date 1437994714 -7200
# Node ID 60cc9b5126d10e5554581c35b80b0e5f113f95e8
# Parent  261095b700a0af01965df690ac804748edc61049
Added README file.

diff -r 261095b700a0 -r 60cc9b5126d1 README.markdown
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown	Mon Jul 27 12:58:34 2015 +0200
@@ -0,0 +1,71 @@
+Lada-Server
+===========
+Die Software bietet Funktionalität zur Erfassung und Bearbeitung
+von Messdaten. Sowie der Planung der Messungen.
+
+Weitere Informationen finden sich auf der Projektwebseite unter
+der Adresse: https://wald.intevation.org/projects/lada/
+
+Die Software entstand im Rahmen einer Software Entwicklung durch die
+Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz in den Jahren 2013
+bis 2015.
+
+Kontakt
+-------
+Bundesamt für Strahlenschutz
+SW2 Notfallschutz, Zentralstelle des Bundes (ZdB)
+Willy-Brandt-Strasse 5
+38226 Salzgitter
+info at bfs.de
+
+Lizenz
+------
+Die Software ist unter der GNU GPL v>=3 Lizenz verfügbar.
+Details siehe die Datei `COPYING`.
+
+Quelltext
+---------
+Die Quelldateien lassen sich wie folgt auschecken:
+```
+hg clone https://scm.wald.intevation.org/hg/lada/lada-server
+```
+
+Entwicklung
+-----------
+Für die Entwicklung wird ein JDK7 und maven3 oder höher benötigt. Sämtliche
+Abhängigkeiten werden von dem maven build System aufgelöst.
+
+Installation
+------------
+Zur Installation der Lada-Anwendung müssen folgende Schritte unternommen werden:
+
+ $ mvn clean compile package
+ $ cd /opt/wildfly8.2.Final/standalone/deployments
+ $ cp /path/where/the/war/file/is/lada-server.war .
+ $ touch lada-server.war.dodeploy
+
+Zum Aktualisieren der Anwendung genügt es, wenn die lada-server.war Datei aktualisiert
+wird.
+
+Die Anwendung ist dann unter dem Pfad "/lada-server" (abhängig vom Archivnamen)
+erreichbar.
+
+Tests
+-----
+Die auf Arquillian basierenden Tests erfordern einen vollständig konfigurierten
+und gestarteten Wildfly Application-Server, da für die Schnittstellentest eine
+Clientanwendung simuliert wird und HTTP-Requests ausgeführt werden.
+
+Das Ausführen der Tests erfolgt durch das Kommando
+
+ $ mvn -Premote-test clean test
+
+Dokumenation
+------------
+Die Entwicklerdokumentation (Javadoc) kann mit dem folgenden Befehl im
+Verzeichnis der Serveranwendung erzeugt werden:
+
+ $ mvn javadoc:javadoc
+
+Der Ordner 'target' enthält dann die Dokumentation im HTML-Format in dem
+Verzeichnis 'site/apidocs'.