Browse Source

update README: Symbolbeschreibung

Tobias Müller 5 years ago
parent
commit
8cc0373794
2 changed files with 21 additions and 26 deletions
  1. 21 26
      README.md
  2. BIN
      README.pdf

+ 21 - 26
README.md

@@ -13,8 +13,8 @@
     * [Installation](#Installation)
     * [Bespielprogramme](#Programme)
     * [Verwenden der Klasse](#LCDCLASS)
+        * [Symbole](#Attribute)
         * [Objekte](#Objekte)
-        * [Attribute](#Attribute)
         * [Methoden](#Methoden)
 3. **[Literaturverzeichnis](#Literaturverzeichnis)**
 
@@ -60,12 +60,12 @@ In der folgenden Tabelle werden die Versionsunterschiede des LCD-Shields ab Vers
 
 | Pin | Version 5 | Version 6 |
 |:----:|:----:|:----:|
-| IO4 | S3 | - |
-| IO5 | S4 | S3 |
-| IO6 | D1 | S4 |
-| IO7 | D2 | D1 |
-| IO8 | Q1 | D2 |
-| IO9 | - | Q1 |
+| <span style="color:#DF0101"> **IO4** </span> | S3 | - |
+| <span style="color:#DF0101"> **IO5** </span> | S4 | S3 |
+| <span style="color:#DF0101"> **IO6** </span> | D1 | S4 |
+| <span style="color:#DF0101"> **IO7** </span> | D2 | D1 |
+| <span style="color:#DF0101"> **IO8** </span> | Q1 | D2 |
+| <span style="color:#DF0101"> **IO9** </span> | - | Q1 |
 
 Bei der Nutzung der LCD-Shield Bibliothek muss entsprechend darauf geachtet werden, welche Shield-Version verwendet wird.
 
@@ -73,9 +73,9 @@ Bei der Nutzung der LCD-Shield Bibliothek muss entsprechend darauf geachtet werd
 
 ## <p>&#x1F5C3; 2. LCD-Shield Bibliothek</p>
 
-In den folgenden Abschnitten wird die LCD-Shield Bibliothek erklärt. Dabei wird auf die Installation, die Verwendung von Beispielprogrammen und die Nutzung der Klasse `HSA_LCD_Shield` eingeganen.
+In den folgenden Abschnitten wird die LCD-Shield Bibliothek erklärt. Dabei wird auf die Installation, die Verwendung von Beispielprogrammen und die Nutzung der Klasse <span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span> eingeganen.
 
-> Sollten zusätzlich Fragen zur Verwendung der LCD-Shield Bibliothek auftauchen, wenden Sie sich an Herrn <a href="mailto:Tobias.Mueller@HS-Anhalt.de">Müller</a>.
+> Sollten zusätzlich Fragen zur Verwendung der LCD-Shield Bibliothek auftauchen, wenden Sie sich bite an Herrn <a href="mailto:Tobias.Mueller@HS-Anhalt.de">Müller</a>.
 
 <div id='Installation'/>
 
@@ -93,7 +93,7 @@ Es öffnet sich der Dateimanager, wo Sie die heruntergeladene Datei auswählen u
 
 ![](https://gogs.es-lab.de/attachments/2c73ace6-9f58-4a21-88b8-edee4bfc299e)
 
-Nun Steht ihnen unter `Sketch`. `Bibliothek einbinden` die `HS-Anhalt LCD-Shield` Bibliothek zur Verfügung und kann in Ihrem Programm eingebunden werden. 
+Nun Steht ihnen unter `Sketch`, `Bibliothek einbinden` die `HS-Anhalt LCD-Shield` Bibliothek zur Verfügung und kann in Ihrem Programm eingebunden werden. 
 
 ![](https://gogs.es-lab.de/attachments/c65c3dbf-7475-465e-a19d-a1bf501e3c9b)
 
@@ -101,7 +101,7 @@ Nun Steht ihnen unter `Sketch`. `Bibliothek einbinden` die `HS-Anhalt LCD-Shield
 
 ### Bespielprogramme
 
-Die Bibliothek beinhaltet Beispielprogramme zum Testen der Funktionalität des LCD-Shields. Des Weiteren dienen die Beispielprogramme zum besseren Verständnis der Klasse `HSA_LCD_Shield`.
+Die Bibliothek beinhaltet Beispielprogramme zum Testen der Funktionalität des LCD-Shields. Des Weiteren dienen die Beispielprogramme zum besseren Verständnis der Klasse <span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span>.
 
 Die Beispielprogramme finden Sie unter `Datei`, `Beispiele`, `HS-Anhalt LCD-Shield`. Entsprechend Ihrer Version des LCD-Shields können Sie das passende Beispielprogramm auswählen.
 
@@ -119,9 +119,14 @@ Im Anschluss können Sie das Beispielprogramm auf Ihrem Arduino hochladen. Befol
 
 ### Verwenden der Klasse
 
-Weitere Informationen folgen!
+In den folgenden Abschnitten werden Symbole, Objekte und Methoden der Klasse 
+<span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span> erklärt, damit diese im eigenen Programm verwendet werden können. Da die Attribute der Klasse geschützt sind und folglich nicht vom Anwender verändert werden können, werden diese hier nicht weiter aufgeführt oder erläutert. 
+
+<div id='Attribute'/>
 
+#### Symbole
 
+Symbole der Klasse <span style="color:#FE9A2E"> **`HSA_LCD_Shield`** </span> werden hauptsächlich zur besseren Lesbarkeit des Quellcodes und zur Parameterübergabe für Objekte und Methoden verwendet. 
 
 <div id='Objekte'/>
 
@@ -129,16 +134,6 @@ Weitere Informationen folgen!
 
 Weitere Informationen folgen!
 
-
-
-<div id='Attribute'/>
-
-#### Attribute
-
-Weitere Informationen folgen!
-
-
-
 <div id='Methoden'/>
 
 #### Methoden
@@ -168,10 +163,10 @@ Weitere Informationen folgen!
 <p>Prof. Dr. Michael Brutscheck<br>
 <a href="mailto:Michael.Brutscheck@HS-Anhalt.de">&#x1F4E7; Michael.Brutscheck@HS-Anhalt.de</a></p>
 
-<p>Tobias Müller, M. Eng.<br>
-<a href="mailto:Tobias.Mueller@HS-Anhalt.de">&#x1F4E7; Tobias.Mueller@HS-Anhalt.de</a></p>
-
 <p>Dipl. Ing. Harald Prütting<br>
 <a href="mailto:Harald.Pruetting@hs-anhalt.de">&#x1F4E7; Harald.Pruetting@HS-Anhalt.de</a></p>
 
-<p>&#x00A9; es-lab.de, 13.11.2018</p>
+<p>Tobias Müller, M. Eng.<br>
+<a href="mailto:Tobias.Mueller@HS-Anhalt.de">&#x1F4E7; Tobias.Mueller@HS-Anhalt.de</a></p>
+
+<p>&#x00A9; HS-Anhalt.de, 26.11.2018</p>

BIN
README.pdf