README: update project documentation

* i18n: howto extend translations
* installation: download via git

Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>
This commit is contained in:
2020-07-08 10:49:02 +02:00
parent ea57346119
commit f9dd2e3797

View File

@@ -1,12 +1,12 @@
<!-- AdvoTracker.markdown -->
<!-- version: 1.1 -->
<!-- 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 Hotline tool f<EFBFBD>r Advokaten
AdvoTracker unterstützt Anwälte bei der Erfassung von Mandatsdaten zu einer Online-Beratung.
`AdvoTracker` unterst<EFBFBD>tzt Anw<EFBFBD>lte bei der Erfassung von Mandatsdaten zu einer Online-Beratung.
Das Tool wurde als multi-Pattform Anwendung konzipiert.
@@ -15,10 +15,64 @@ GUI Elemente erfolgt mit der Klassenbibliothek *OrbTk*.
Als Dokumentationsquellen wird auf die offiziellen Projektseiten [Rust Book][^1] und [OrbTk][^2] verwiesen.
# Internationalisierung #
# Internationalisierung
In allen Dialogen und Meldungen erfolgt die Ausgabe entsprechend der Sprache, die als
aktive Sprache in der Umgebungsvariable definiert ist (default: LANG = en_US.UTF8 ) ausgewählt.
Alle Dialoge und Meldungen verwenden f<>r die Ausgabe von Texten, die vom Anwender
gew<EFBFBD>hlte Sprache. Sie kann <20>ber eine Umgebungsvariable ausgew<65>hlt und angepasst
weren (default: LANG = en_US.UTF8 ).
Die <20>bersetzten Sprachtexte finden sich im Quell-Code Unterverzeichnis 'locales'
(<src-root>/advotracker/src/locales/advotracker.json).
F<EFBFBD>r jeden unterst<73>tzen Sprach-String existiert ein Block mit der generischen
Nachrichten Kennung, gefolgt von spachspezifischen <20>bersetzungszeilen.
Die <20>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<70>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<EFBFBD>r die Erstellung des ausf<73>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<75>ck.
- ** Kompilieren
Ein f<>r das Zielsystem passendes binary wird durch folgenden Aufruf erzeugt:
```sh
<advotracker_root> $ cargo build --release
```
- ** Installation
Die Toolchain unsterst<73>tzt auch die Installation der ausf<73>hrbaren Programme:
```sh
<advotracker_root> $ cargo install
```
Zus<EFBFBD>tzlich kopieren sie bitte noch den Ordner mit den Ressourcen in das
Zielverzeichnis (enth<74>lt fonts, images und stylesheets).
---
@@ -36,3 +90,4 @@ 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/