From d5c399120f7f48718c10c30bf94dfd9dc17a57b8 Mon Sep 17 00:00:00 2001 From: Ilya Elenskiy Date: Wed, 15 Apr 2020 23:50:14 +0200 Subject: [PATCH] Readme => German --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 320e7fb..8b48408 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -# On-board peripheral libraries for EMG DMM boards +# Peripheriebibliothek für das DMM Board -See [DMM-Demo](https://teach.emg.ing.tu-bs.de/git/dmm/dmm-demo) for usage and -board definitions. +Siehe [DMM-Demo](https://teach.emg.ing.tu-bs.de/git/dmm/dmm-demo) für Beispiele +sowie Bootloader und Board-Konfiguration. ## PlatformIO -Include into project by adding to `platformio.ini`: +Um die Bibliothek in das Projekt einbinden füge Referenz ins `platformio.ini` +des Projektes wie folgt ein: ``` [env] ... @@ -12,15 +13,18 @@ lib_deps = git@teach.emg.ing.tu-bs.de:dmm/dmm-libs.git ``` - -By default, the libraries will be downloaded into the hidden workspace folder. -For easier inspection, you can change the directory to make it browsable by -adding: + +Bei der nächsten Kompilierung mit `pio run` wird die Bibliothek automatisch +heruntergeladen. Eine Aktualisierung kann mit `pio lib update` erzwungen werden. + +Standardmäßig werden die Bibliotheken in einen versteckten Workspace-Ordner +abgelegt. Will man sich den Quellcode im Projektordner ansehen können +(empfohlen!), kann ein Ordner innerhalb des Projektes vorgegeben werden: ``` [platformio] default_envs = release libdeps_dir = depends ``` - -You should avoid uploading PIO-managed external libraries into you project's -git. Therefore you should also add `depends` into your `.gitignore`. +In diesem Fall sollte man davon absehen, die automatisch vom PIO +heruntergeladenen Bibliotheken ins Git des eigenen Projektes einzuchecken. +Es empfiehlt sich in dem Fall `depends` ins `.gitignore` einzufügen.