I18N: README.md language variants (v0.1.2)
* update contents inside README.md * provide language variant (english, german) * document translation handling * installation: download via git Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>
This commit is contained in:
166
locales/german/README.md
Normal file
166
locales/german/README.md
Normal file
@@ -0,0 +1,166 @@
|
||||
<!-- AdvoTracker README.md -->
|
||||
<!-- version: 0.1.2 -->
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
<p align="center">
|
||||
<span>English</span> |
|
||||
<a href="../..">Englisch</a>
|
||||
<!-- a href="../spanish">Spanisch</a> | -->
|
||||
</p>
|
||||
|
||||
|
||||
# AdvoTracker Hotline Tools f<>r Advokaten
|
||||
|
||||
`AdvoTracker` unterst<73>tzt Anw<6E>lte bei der Erfassung von Mandatsdaten zu einer Online-Beratung.
|
||||
|
||||
Die Anwendungskomonenten sind in der Programmiersprache *Rust* implementiert.
|
||||
Die graphischen Benutzerschnittstelle (GUI) verwendet die Klassenbibliothek *OrbTk*, die
|
||||
ebenfalls in *Rust* entwickelt wird.
|
||||
|
||||
Die Anwendung ist auf allen durch das Toolkit unterst<73>tzen Pattformen ablauff<66>hig.
|
||||
Hierzu z<>hlen derzeit:
|
||||
|
||||
* macOS
|
||||
* Linux
|
||||
* openBSD
|
||||
* Redox OS
|
||||
* Web-Browser
|
||||
* Windows
|
||||
|
||||
In Entwicklung befinden sich native Portierungen auf folgende Systeme:
|
||||
|
||||
* Android
|
||||
* iOS
|
||||
* ubuntu Touch
|
||||
|
||||
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<EFBFBD>hlte Sprache. Sie kann <20>ber eine Umgebungsvariable ausgew<65>hlt und angepasst
|
||||
werden (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 aus dem 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
|
||||
$ cd <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.
|
||||
|
||||
## native Anwendung f<>r das Ziel-System
|
||||
|
||||
Ein f<>r das Zielsystem passendes binary wird durch folgenden Aufruf erzeugt:
|
||||
|
||||
```sh
|
||||
$ cd <advotracker_root>
|
||||
$ cargo build --release
|
||||
```
|
||||
Die Toolchain unterst<73>tzt auch die Erstellung von binaries f<>r andere Ziel-Systeme (cross-compile).
|
||||
Bitte lesen sie hierzu in der `Rust` Dokumentation f<>r weiterf<72>hrende Instruktionen.
|
||||
|
||||
### Web-Browser Anwendung
|
||||
|
||||
Um `Advotracker` als Web Applikation zu starten (web-browser, electron, cordova),
|
||||
muss zun<75>chst das crate `cargo-node` installiert werden:
|
||||
|
||||
```sh
|
||||
cargo install -f cargo-node
|
||||
```
|
||||
|
||||
`cargo-node` ben<65>tigt seinerseits eine Version von `npm` (>=v6.9.0), dem
|
||||
Node Paketmanager. Im Downlaod von `[Node.js][^4]` ist npm enthalten.
|
||||
|
||||
- **Browser App**
|
||||
|
||||
Mit dem nachfolgend angef<65>hrten Befehl wird `Advotracker` als WEB-Browser App gestartete.
|
||||
Verbinden Sie sich anschlie<69>end mit Angabe der definierten URL in Ihrem Browser-Fenster
|
||||
mit der App.
|
||||
|
||||
```sh
|
||||
cargo node run --target browser advotracker
|
||||
```
|
||||
|
||||
- **Electron App**
|
||||
|
||||
```sh
|
||||
cargo node run --target electron advotracker
|
||||
```
|
||||
|
||||
- **Android App**
|
||||
|
||||
```sh
|
||||
cargo node run --target android advotracker
|
||||
```
|
||||
|
||||
## Erstellen der Dokumentation
|
||||
|
||||
Die aktuelle Dokumentation wird mit dem nachfolgenden Befehl erzeugt:
|
||||
|
||||
```sh
|
||||
cargo doc --no-deps --open
|
||||
```
|
||||
|
||||
Die Dokumentationspassagen werden aus dem Quellcode extrahiert, und als WEB Seiten
|
||||
aufbereitet. Ist die Erstellung abgeschlossen, wird ein neuer Tabulator mit den
|
||||
Dokumentationsseiten in Ihrem WEB-Browser ge<67>ffnet.
|
||||
|
||||
## Installation
|
||||
|
||||
Die Toolchain unterst<73>tzt die Installation der ausf<73>hrbaren Programme:
|
||||
|
||||
```sh
|
||||
cd <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).
|
||||
|
||||
---
|
||||
|
||||
[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"
|
||||
Diese Dokument ist lizensiert unter der [Creative Common License 4.0][License-CC_BY]
|
||||
|
||||
![Creative Common Logo][Logo-CC_BY]
|
||||
|
||||
<EFBFBD> 2020 Ralf Zerres, Networkx GmbH
|
||||
|
||||
---
|
||||
|
||||
Fussnoten
|
||||
|
||||
[^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/
|
||||
[^4]: Node.js: https://nodejs.org/dist/v10.16.3/
|
||||
Reference in New Issue
Block a user