Files
advotracker/README.md
Ralf Zerres f9dd2e3797 README: update project documentation
* i18n: howto extend translations
* installation: download via git

Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>
2020-07-12 19:23:47 +02:00

94 lines
3.1 KiB
Markdown
Executable File

<!-- AdvoTracker.markdown -->
<!-- version: 0.1.2 -->
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
<!-- markdown-toc end -->
# AdvoTracker Hotline tool für Advokaten
`AdvoTracker` unterstützt Anwälte bei der Erfassung von Mandatsdaten zu einer Online-Beratung.
Das Tool wurde als multi-Pattform Anwendung konzipiert.
Als Programmiersprache wird *Rust* verwendet. Die Implementierung der
GUI Elemente erfolgt mit der Klassenbibliothek *OrbTk*.
Als Dokumentationsquellen wird auf die offiziellen Projektseiten [Rust Book][^1] und [OrbTk][^2] verwiesen.
# Internationalisierung
Alle Dialoge und Meldungen verwenden für die Ausgabe von Texten, die vom Anwender
gewählte Sprache. Sie kann über eine Umgebungsvariable ausgewählt und angepasst
weren (default: LANG = en_US.UTF8 ).
Die übersetzten Sprachtexte finden sich im Quell-Code Unterverzeichnis 'locales'
(<src-root>/advotracker/src/locales/advotracker.json).
Für jeden unterstützen Sprach-String existiert ein Block mit der generischen
Nachrichten Kennung, gefolgt von spachspezifischen Übersetzungszeilen.
Die Übersetzungszeilen werden mit dem ISO Code der jeweiligen Sprache identifiziert.
# Installation
## Quell-Code
Sie können den Quell-Code von `Advotracker` unter folgender URL als Zip-Datei,
oder unter Verwendung von `git` herunterladen.
Der Quell-Code ist in drei Submodule untergliedert:
* advotracker
* advotrackerd
* advotracker-db
Da derzeit ein signiertes Softwarezertifikat einer Microsoft Zertifizierungsstelle
verwendet wird, kann git die Gültigkeit dieses Zertifikats nicht gegen die
offiziellen CA-Listen prüfen. Bitte gehen sie wie folgt vor:
```sh
<your_path> $ git -c http.https://gitea.networkx.de:50443.sslverify=false \
clone --recurses-submodules --jobs=10 \
https://gitea.networkx.de:50443/rzerres/advotracker
```
Für die Erstellung des ausführbaren Programm-Codes wird die Rust Toolchain-Umgebung
verwendet. Sollten diese noch nicht auf Ihrem Entwicklungssystem installiert sein,
verwenden sie entweder den von der Rust-Entwicklergemeinde bereitgestellten
Toolchain-Installer [rustup][^3], oder greifen auf Installationspakete des
Paketmanagers auf ihrem Betriebssystem zurück.
- ** Kompilieren
Ein für das Zielsystem passendes binary wird durch folgenden Aufruf erzeugt:
```sh
<advotracker_root> $ cargo build --release
```
- ** Installation
Die Toolchain unsterstützt auch die Installation der ausführbaren Programme:
```sh
<advotracker_root> $ cargo install
```
Zusätzlich kopieren sie bitte noch den Ordner mit den Ressourcen in das
Zielverzeichnis (enthält fonts, images und stylesheets).
---
[Logo-CC_BY]: https://i.creativecommons.org/l/by/4.0/88x31.png "Creative Common Logo"
[License-CC_BY]: https://creativecommons.org/licenses/by/4.0/legalcode "Creative Common License"
This work is licensed under a [Creative Common License 4.0][License-CC_BY]
![Creative Common Logo][Logo-CC_BY]
© 2020 Ralf Zerres, Networkx GmbH
---
Foodnotes
[^1]: Rust Book: https://doc.rust-lang.org/book/
[^2]: OrbTK GUI: https://gitlab.redox-os.org/redox-os/orbtk
[^3]: Rustup: https://rustup.rs/