Skip to content

Commit df90244

Browse files
author
sidey79
committed
fix(docs): aktualisiere Installationsanweisungen und verbessere die Dokumentation
1 parent cdf99a9 commit df90244

File tree

3 files changed

+23
-22
lines changed

3 files changed

+23
-22
lines changed

docs/01_user_guide/installation.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Installation
1+
== Installation
22

33
[NOTE]
44
====
@@ -31,7 +31,9 @@ Die einfachste Methode ist die Installation aus dem geklonten Repository im Entw
3131

3232
[source,bash]
3333
----
34-
include::../examples/bash/install_via_pip.sh[]
34+
git clone https://github.com/Ein-Einfaches-Beispiel/PySignalduino.git
35+
cd PySignalduino
36+
pip install -e .
3537
----
3638

3739
Dadurch wird das Paket `signalduino-mqtt` in Ihrer Python-Umgebung installiert und alle Runtime-Abhängigkeiten werden erfüllt.
@@ -42,7 +44,7 @@ Falls Sie das Paket nicht installieren, sondern nur die Abhängigkeiten nutzen m
4244

4345
[source,bash]
4446
----
45-
include::../examples/bash/install_requirements.sh[]
47+
pip install -r requirements.txt
4648
----
4749

4850
Die Datei `requirements.txt` enthält die gleichen Pakete wie oben aufgelistet.
@@ -53,7 +55,7 @@ Für Beiträge zum Projekt oder zum Ausführen der Tests installieren Sie zusät
5355

5456
[source,bash]
5557
----
56-
include::../examples/bash/install_dev_requirements.sh[]
58+
pip install -r requirements-dev.txt
5759
----
5860

5961
Dies installiert:
@@ -69,7 +71,7 @@ Dies installiert:
6971

7072
[source,bash]
7173
----
72-
include::../examples/bash/verify_installation.sh[]
74+
python3 main.py --help
7375
----
7476

7577
Sie sollten eine Ausgabe mit allen verfügbaren Kommandozeilenoptionen sehen.

docs/02_developer_guide/contribution.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
====
55
Da PySignalduino noch in aktiver Entwicklung ist, können sich Code-Strukturen und APIs schnell ändern.
66
Bitte synchronisieren Sie Ihren Fork regelmäßig mit dem upstream-Repository.
7+
====
78

89
Beiträge zum Projekt sind willkommen!
910

@@ -52,11 +53,12 @@ Es gibt keine strikte CI-Prüfung, aber konsistenter Stil wird erwartet.
5253
Für alle AsciiDoc-Dateien im `docs/` Verzeichnis ist die Regel "Ein Satz pro Zeile" verpflichtend.
5354
Dies erleichtert die Überprüfung von Änderungen mittels `git diff`.
5455

55-
[NOTE]
56+
[IMPORTANT]
5657
====
5758
Jeder Satz muss auf einer neuen Zeile beginnen.
5859
Ein Satz endet typischerweise mit einem Punkt (`.`), Ausrufezeichen (`!`) oder Fragezeichen (`?`).
5960
Achten Sie darauf, dass Codeblöcke und Tabellen nicht betroffen sind.
61+
====
6062

6163
== Tests ausführen
6264

docs/index.adoc

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,46 @@ Dadurch werden verschiedenste proprietäre Funkprotokolle für die Nutzung in Sm
1616
Die verfügbare Hardware-Basis reicht von einfachen Arduino/nanoCUL-Lösungen bis hin zu erweiterten Varianten wie dem Maple-SignalDuino und dem ESP32-SignalDuino, die erweiterte Funktionen (z.B. WLAN) bieten.
1717

1818
.Übersicht: Hardware und Funktion
19-
[NOTE]
20-
====
2119

2220
[mermaid]
2321
----
2422
graph TD
25-
subgraph Input (Funksignale)
23+
subgraph "Input (Funksignale)"
2624
A[433/868 MHz Signale]
2725
B[Sensoren / Fernbedienungen]
2826
end
2927
30-
subgraph Hardware-Plattform
28+
subgraph "Hardware-Plattform"
3129
C[CC1101 Funkmodul]
3230
D[Arduino Nano]
3331
E[ESP8266 / ESP32]
3432
end
3533
36-
subgraph PySignalduino (Software-Verarbeitung)
34+
subgraph "PySignalduino (Software-Verarbeitung)"
3735
F[Empfangen / Senden]
3836
G[Protokolldemodulation]
39-
H[Dekodierung (Protokolle)]
37+
H[Dekodierung Protokolle]
4038
end
4139
42-
subgraph Output (Home Automation)
40+
subgraph "Output (Home Automation)"
4341
I[MQTT Bridge]
4442
J[Serielle Schnittstelle]
4543
K[FHEM / Home Assistant / ioBroker]
4644
end
4745
4846
A --> C
4947
B --> C
50-
C -- Funksignale --> F
51-
D -- Strom/Schnittstelle --> F
52-
E -- Strom/Schnittstelle --> F
53-
54-
F -- Rohdaten --> G
55-
G -- Demodulierte Daten --> H
56-
H -- Decodierte Nachricht --> I
57-
H -- Decodierte Nachricht --> J
48+
C -- "Funksignale" --> F
49+
D -- "Strom/Schnittstelle" --> F
50+
E -- "Strom/Schnittstelle" --> F
51+
52+
F -- "Rohdaten" --> G
53+
G -- "Demodulierte Daten" --> H
54+
H -- "Decodierte Nachricht" --> I
55+
H -- "Decodierte Nachricht" --> J
5856
I --> K
5957
J --> K
6058
----
61-
====
6259

6360
[[section-historie]]
6461
== Projektgeschichte und Entwicklung

0 commit comments

Comments
 (0)