Reference-de

Reference-de ist das Repository der Arduino-Programmiersprachen-Referenzdokumentation in Deutsch.

Alle Referenz-Dateien existieren im AsciiDoc format.

Danke, dass du die Zeit findest, zum Arduino-Projekt beizutragen. Das hilft der ganzen Arduino Community sehr weiter. Wenn du mehr lesen willst, wie du deinen Beitrag leisten kannst, sieh dir dieses Schritt-für-Schritt-Tutorial an.

Inhalte erstellen und editieren

Wenn du neuen Inhalt bereitstellen willst, erstelle eine neue Datei (Mit deinem Lieblings-Code-Editor) und speichere die Datei als .asdoc-Format. Bitte benutze keine Klammern oder andere Sonderzeichen im Dateinamen. Unter reference-de/AsciiDoc_sample/AsciiDoc_Dictionary findest du einen Überblick über die AsciiDoc-Syntax. Diese schließt Titel, Text, Links, Bilder, Tabellen, Programmcode und viele andere eingebettete Typen (Videos, Präsentationen, Audio und Code) ein. Eine Vorschau dazu findest du hier.

Wenn du zur Arduino-Referenz Beitrag leisten willst oder Inhalte ändern, kannst du 2 Templates in reference-de/AsciiDoc_sample/Reference_Terms finden:

• Nutze AsciiDoc_Template-Single_Entity.adoc (Gerenderte Version hier) für Begriffe wie analogWrite.

• Nutze AsciiDoc_Template-Parent_Of_Entities.adoc (Gerenderte Version hier) für Gruppen oder Funktionen wie Serial.

Bitte beachte, dass jede Datei in der Referenz mindestens eine Beschreibung, Beispielcode und Links zu anderen relevanten Informationen enthält (Siehe Also Abschnitt).

Wenn du Bilder in die Asciidoc-Datei einfügen willst, erstelle bitte einen Ordner attachments im gleichen Ordner wie die Asciidoc-Datei. Bilder können im SVG- und PNG-Format gespeichert werden. Die maximale Größe beträgt hierbei 200KB.

Trage zum Inhalt auf Github bei

Wenn du mit Git nicht vertraut bist, kannst du Inhalte direkt über den Online-Editor einfügen. Ein kurzes Tutorial, wie das geht, findest du hier: SIEH ES DIR AN!

Du kannst auch dieser Anleitung folgen (geschrieben vom Github-Team), um zu lernen, wie du eine .adoc-Datei editieren kannst und Dateiänderungen an das Arduino-Team vorschlagen kannst. Wenn du eine Änderung vorschlagen willst, folge bitte den Guidelines in den Referenz-Templates.

Pull request stellen

Wir freuen uns, dass du zur Arduino-Referenz beitragen willst: Das ist der beste Weg, der Community zu helfen.

Dein Beitrag fügt neue Inhalte hinzu oder ändert existierenden Code oder Beschreibungen, bitte verweise bei Änderungen immer auf einen offenen Github-Issue oder erstelle einen Neuen, bevor du Änderungen einbringst.

Ordnerstruktur

reference-de
├─ AsciiDoc_sample
│   ├── AsciiDoc_Dictionary
│   │   ├── AsciiDoc_Template-Dictionary.adoc
│   │   └── attachments
│   └── Reference_Terms
│       ├── AsciiDoc_Template-Parent_Of_Entities.adoc
│       ├── AsciiDoc_Template-Single_Entity.adoc
│       └── attachments
├── Language
│   ├── Functions
│   ├── Structure
│   └── Variables
├── LICENCE.md
└── README.adoc

Im Language-Ordner folgt der Dateibaum der gleichen Struktur wie die Arduino-Referenz-Webseite

Lizenz

Bitte beachte, dass dein Beitrag zur Arduino-Referenz unter der Creative Commons Attribution-Share Alike 3.0 License lizensiert wird. Siehe https://creativecommons.org/licenses/by-sa/3.0/deed.de

Dieses Werk ist lizenziert unter einer Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 3.0 Unported Lizenz.