Skip to content
This repository was archived by the owner on Jul 22, 2020. It is now read-only.

documentation.md

Latest commit

 

History

History
39 lines (22 loc) · 2.85 KB

documentation.md

File metadata and controls

39 lines (22 loc) · 2.85 KB
Raw

Dokumentation

Autor: Randall Munroe[1], CC BY-NC 2.5 Lizenz.

Wir haben ein Github Repo[2] für die OpenPlotter Dokumentation. Dieses Repo ist angeschlossen an ein Gitbook Buch[3] und wir koordinieren die Redakteure in einem Forum[4] auf OpenMarine.

Wenn Du uns helfen möchtest zu schreiben, aktualisieren, korrigieren oder übersetzen, hast Du zwei Möglichkeiten:

Du bist vertraut mit Github und Gitbook Repo's:

  • Mache Dir einen Account bei Github[5]
  • Sende Deinen Github Zugangs-Namen zu diesem Forum[4] und warte, bis Dir die Berechtigung zum Editieren des Repos erhälst.
  • Aus dem Beitrag im oberen Bereich des Forums[4] suche Dir ein blau markiertes Kapitel aus und teile Dein Vorhaben in einem neuen Thread mit.
  • Wenn Du die Berechtigung erhalten hast, melde Dich bei Gitbook[6] mit Deinem Zugangsnamen an.
  • Gehe zum Buch[3] und wähle oben rechts den Edit button aus.

Wenn Du mit Github und Gitbook Repo's nicht vertraut bist:

  • Such Dir aus dem Beitrag im oberen Bereich des Forums[4] ein blau markiertes Kapitel aus und teile Dein Vorhaben in einem neuen Thread mit.
  • Sobald Du fertig bist, kopiere den Text und die Bilder in einen neuen Thread im Forum[4] und jemand wird es für Dich in das Buch für Dich einbauen.

Schreiben

Wir schreiben die Ursprungs-Dokumentation in englisch um die Übersetzung in andere Sprachen möglichst einfach zu machen.

Bitte ändere nicht das Inhaltsverzeichnis oder die Struktur ohne einen Entwickler oder Admin zu fragen. Wenn ein Kapital fertig ist, teile dies im Forum[4] mit, damit es grün markiert ist.

Um die Bilder aus dem englischen Ordner in anderen Sprachen ebenfalls darstellen zu können, nutze diesen Pfad: ../en/xxx.png

Wenn Du Verdrahtungen oder Anschlußbelegungen darstellen möchtest, solltest Du es mit der Fritzing-Software[7] machen.

Ändere oder übersetze nicht die Dateinamen (xxx.md xxx.png xxx.jpg ...), weil in den Texten hierauf referenziert wird.

[1] https://xkcd.com [2] https://github.com/sailoog/openplotter-documentation [3] https://www.gitbook.com/book/sailoog/openplotter-documentation/details [4] http://forum.openmarine.net/forumdisplay.php?fid=16 [5] https://github.com/join [6] https://www.gitbook.com/login [7] http://fritzing.org