dustin@897: Lada-Client
dustin@897: ===========
dustin@897: Dies ist eine Kopie des ExtJS basierten Klienten für die
dustin@897: Verarbeitung von Labordaten (Lada) zur Überwachung der Umweltradioaktivität.
dustin@897: 
dustin@897: Die Software bietet Funktionalität zur Erfassung und Bearbeitung
dustin@897: von Messdaten. Sowie der Planung der Messungen.
dustin@897: 
dustin@897: Weitere Informationen finden sich auf der Projektwebseite unter
dustin@897: der Adresse: https://wald.intevation.org/projects/lada/
dustin@897: 
dustin@897: Die Software entstand im Rahmen einer Software Entwicklung durch die
dustin@897: Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz in den Jahren 2013
dustin@897: bis 2015.
dustin@897: 
dustin@897: Kontakt
dustin@897: -------
dustin@897: Bundesamt für Strahlenschutz
dustin@897: SW2 Notfallschutz, Zentralstelle des Bundes (ZdB)
dustin@897: Willy-Brandt-Strasse 5
dustin@897: 38226 Salzgitter
dustin@897: info@bfs.de
dustin@897: 
dustin@897: Lizenz
dustin@897: ------
dustin@897: Die Software ist unter der GNU GPL v>=3 Lizenz verfügbar.
dustin@897: Details siehe die Datei `COPYING`.
dustin@897: 
dustin@897: Quelltext
dustin@897: ---------
dustin@897: Die Quelldateien lassen sich wie folgt auschecken:
dustin@897: ```
dustin@897: hg clone https://scm.wald.intevation.org/hg/lada/lada-client
dustin@897: ```
dustin@897: 
dustin@897: Dokumentation
dustin@897: -------------
dustin@897: Die Dokumentation wird mit dem Tool JSDuck erzeugt.
dustin@897: Im Wurzelordner lässt sich nach der Installation von JSDuck dann mit dem
dustin@897: Befehl `jsduck` die Dokumentation für den Lada-Klienten erzeugen.
dustin@897: Die Dokumentation findet sich nach der Generierung in dem Order `doc`.
dustin@897: Einstiegsseite ist die Seite `template.html`.
dustin@897: Sollte die Dokumentation mit einem Webserver ausgeliefert werden auf dem
dustin@897: PHP installiert ist, kann auch die `index.php` verwendet werden.
dustin@897: 
dustin@897: JSDuck ist unter der Adresse https://github.com/senchalabs/jsduck
dustin@897: zu finden und muss installiert werden.
dustin@897: 
dustin@897: Einstellungen bezüglich der Generierung der Dokumentation sind in der Datei
dustin@897: `jsduck.json` hinterlegt.
dustin@897: 
dustin@897: Entwicklung
dustin@897: -----------
dustin@897: Für die Entwicklung ist es notwendig in dem Wurzelordner die ExtJS-Bibliothek
dustin@897: in der Version >=4.2.0 unter dem Namen "extjs" zur Verfügung zu stellen.
dustin@897: 
dustin@897: Näheres dazu in der Datei `INSTALL.markdown`.
dustin@897: 
dustin@897: Zusätzlich werden für diese Anwendung weitere externe Bibliotheken, bspw. zur
dustin@897: Internationalisierung verwendet. Auch diese und deren Installation
dustin@897: sind in der o.g. Datei beschrieben.
dustin@897: 
dustin@897: 
dustin@897: Build
dustin@897: -----
dustin@897: Die Anwendung wird mit Hilfe des von Sencha bereitgestellten Tools 'Sencha Cmd'
dustin@897: kompiliert und minifiziert. Vorbedingung für den Compilevorgang ist die in der
dustin@897: Datei `INSTALL.markdown` beschriebene Verzeichnisstruktur.
dustin@897: 
dustin@897: Der Build erzeugt in dem Ordner 'build' die minifizierte Version der Anwendung,
dustin@897: welche alle benötigten Klassen der ExtJS Bibliothek beinhaltet, sowie eine
dustin@897: entsprechende index.html, die zur Auslieferung in einem Webserver verwendet
dustin@897: werden kann. Externe Bibliotheken, Grafiken und CSS Dateien sind jedoch nicht
dustin@897: inkludiert und müssen händisch hinzugefügt werden. Auch diese sind in der Datei
dustin@897: `INSTALL.markdown` beschrieben.
dustin@897: 
dustin@897: Installation
dustin@897: ------------
dustin@897: Für Informationen zur Installation schauen Sie in die `INSTALL.markdown` Datei.