annotate README.markdown @ 1217:4270da0f7d3b

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

http://lada.wald.intevation.org