

Richtlinien
===========


Versionierung
-------------

Der Versionierung bedürfen meherere Teile des Projekts. Dazu gehören:
* Hardware
* Software
* Mechanik
* Dokumentation
* Gesamtsystem.

Die genaue Lösung des Problems ist noch nicht definiert.

Soweit erhält das Gesamtsystem wohl eine Stückliste mit gültigen Referenzen auf Dokumentation sowie Schaltplänen und Quellcode.

Dokumentation trägt seine Version im Namen mit dem Zusatz -vnn-mm, wobei nn die Haupt-Version bezeichnet und mm Revisionen darstellen. Schaltpläne und Quellcode bekommen jeweils einen neuen Ordner im Stile von "HW/vnn-mm" bzw. "SW/vnn-mm". Ähnlich gilt für die Dokumentation die Ordnerstruktur "<Dokumententitel>/vnn-mm".

Der Zusatz "-nightly" bezeichnet eine Version die noch in Bearbeitung ist aber die abschließende Versionnummer kann sich auch laufend ändern. Der Zusatz "-eng" bezeichnet eine gesicherten Versionsstand, der nicht zu einem abgeschlossenen Release führt und zum sichern eines Zwischenstandes dient.

Verschiedene Elemente brauchen ein Changelog.

Material braucht eine Seriennummer und eine Referenz auf ein Gesamtsystem.


Formatierung
------------

Eine Untermenge der CommonMark-Syntax verwenden! Details zu dessen Definitionen finden sich in dessen [Online-Dokumentation][CM].

[CM]: http://commonmark.org/ "CommonMark"

### Kurz und Knapp

    Header 1
    ========
    
    
    Header 2
    --------
    
    ### Header 3
    
    Paragraph with [Weblink][1]
    
    * List 1
    * List 2
    * List 3
    
    [1]: http://www.mikrocontroller.net "My Home" 

Die erste Überschrift enthält den Dokumententitel der gleich dem Dateinamen ist.

Wenn ein lesbares Dokument als HTML erzeugt wird, dann müssen dem generierten Markup folgende HTML-Elemente vorangesetzt werden:

    <!DOCTYPE html><html><head><meta charset="UTF-8"><body>

Zudem müssen folgende HTML-Elemente dem generierten Markup angehängt werden:

    </body></html>

Das generieren kann [Online][DING] oder über den Referenz-Parser erfolgen

[DING]: http://spec.commonmark.org/dingus.html "Dingus"


Freigabevorgang
---------------

1. Keine Fehler oder Warnungen beim kompilieren der Software.
2. Warenkörbe bei Reichelt aktualisiert und in der Aufbauanleitung nachgezogen.
3. Dokumentation gemäß Richtlinien-Dokument in HTML konvertieren.
4. Aufbau Gesamtsystem aktualisieren.
5. Wiki aktualisieren.
6. EAGLE meldet keine DRC- oder ERC-Fehler.
7. TODO-Liste aktualisieren.
8. Zusatz "nightly" entfernen.