Mercurial > lada > lada-client
comparison README.markdown @ 897:44e970cec920
Moved README to a markdown file, fixed typos in INSTALL.markdown
| author | Dustin Demuth <dustin@intevation.de> |
|---|---|
| date | Fri, 24 Jul 2015 11:04:40 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 896:237bca579fc7 | 897:44e970cec920 |
|---|---|
| 1 Lada-Client | |
| 2 =========== | |
| 3 Dies ist eine Kopie des ExtJS basierten Klienten für die | |
| 4 Verarbeitung von Labordaten (Lada) zur Überwachung der Umweltradioaktivität. | |
| 5 | |
| 6 Die Software bietet Funktionalität zur Erfassung und Bearbeitung | |
| 7 von Messdaten. Sowie der Planung der Messungen. | |
| 8 | |
| 9 Weitere Informationen finden sich auf der Projektwebseite unter | |
| 10 der Adresse: https://wald.intevation.org/projects/lada/ | |
| 11 | |
| 12 Die Software entstand im Rahmen einer Software Entwicklung durch die | |
| 13 Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz in den Jahren 2013 | |
| 14 bis 2015. | |
| 15 | |
| 16 Kontakt | |
| 17 ------- | |
| 18 Bundesamt für Strahlenschutz | |
| 19 SW2 Notfallschutz, Zentralstelle des Bundes (ZdB) | |
| 20 Willy-Brandt-Strasse 5 | |
| 21 38226 Salzgitter | |
| 22 info@bfs.de | |
| 23 | |
| 24 Lizenz | |
| 25 ------ | |
| 26 Die Software ist unter der GNU GPL v>=3 Lizenz verfügbar. | |
| 27 Details siehe die Datei `COPYING`. | |
| 28 | |
| 29 Quelltext | |
| 30 --------- | |
| 31 Die Quelldateien lassen sich wie folgt auschecken: | |
| 32 ``` | |
| 33 hg clone https://scm.wald.intevation.org/hg/lada/lada-client | |
| 34 ``` | |
| 35 | |
| 36 Dokumentation | |
| 37 ------------- | |
| 38 Die Dokumentation wird mit dem Tool JSDuck erzeugt. | |
| 39 Im Wurzelordner lässt sich nach der Installation von JSDuck dann mit dem | |
| 40 Befehl `jsduck` die Dokumentation für den Lada-Klienten erzeugen. | |
| 41 Die Dokumentation findet sich nach der Generierung in dem Order `doc`. | |
| 42 Einstiegsseite ist die Seite `template.html`. | |
| 43 Sollte die Dokumentation mit einem Webserver ausgeliefert werden auf dem | |
| 44 PHP installiert ist, kann auch die `index.php` verwendet werden. | |
| 45 | |
| 46 JSDuck ist unter der Adresse https://github.com/senchalabs/jsduck | |
| 47 zu finden und muss installiert werden. | |
| 48 | |
| 49 Einstellungen bezüglich der Generierung der Dokumentation sind in der Datei | |
| 50 `jsduck.json` hinterlegt. | |
| 51 | |
| 52 Entwicklung | |
| 53 ----------- | |
| 54 Für die Entwicklung ist es notwendig in dem Wurzelordner die ExtJS-Bibliothek | |
| 55 in der Version >=4.2.0 unter dem Namen "extjs" zur Verfügung zu stellen. | |
| 56 | |
| 57 Näheres dazu in der Datei `INSTALL.markdown`. | |
| 58 | |
| 59 Zusätzlich werden für diese Anwendung weitere externe Bibliotheken, bspw. zur | |
| 60 Internationalisierung verwendet. Auch diese und deren Installation | |
| 61 sind in der o.g. Datei beschrieben. | |
| 62 | |
| 63 | |
| 64 Build | |
| 65 ----- | |
| 66 Die Anwendung wird mit Hilfe des von Sencha bereitgestellten Tools 'Sencha Cmd' | |
| 67 kompiliert und minifiziert. Vorbedingung für den Compilevorgang ist die in der | |
| 68 Datei `INSTALL.markdown` beschriebene Verzeichnisstruktur. | |
| 69 | |
| 70 Der Build erzeugt in dem Ordner 'build' die minifizierte Version der Anwendung, | |
| 71 welche alle benötigten Klassen der ExtJS Bibliothek beinhaltet, sowie eine | |
| 72 entsprechende index.html, die zur Auslieferung in einem Webserver verwendet | |
| 73 werden kann. Externe Bibliotheken, Grafiken und CSS Dateien sind jedoch nicht | |
| 74 inkludiert und müssen händisch hinzugefügt werden. Auch diese sind in der Datei | |
| 75 `INSTALL.markdown` beschrieben. | |
| 76 | |
| 77 Installation | |
| 78 ------------ | |
| 79 Für Informationen zur Installation schauen Sie in die `INSTALL.markdown` Datei. |