cryptoadvocate/dcsgonefwbspDie Heimat des Firmware-Board-Support-Pakets des ersten elektronischen Badge-Projekts von Circuit Crafters.
Um Ihnen den Einstieg in GitLab zu erleichtern, finden Sie hier eine Liste empfohlener nächster Schritte.
Bereits ein Profi? Bearbeiten Sie einfach diese README.md und machen Sie sie zu Ihrer eigenen. Möchten Sie es einfach haben? Verwenden Sie die Vorlage unten!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/dcsgonefwbsp.git
git branch -M main
git push -uf origin main
Nutzen Sie die integrierte kontinuierliche Integration in GitLab.
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.
Jedes Projekt ist anders, überlegen Sie daher, welche dieser Abschnitte auf Ihr Projekt zutreffen. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open-Source-Projekte. Beachten Sie auch, dass eine README zwar zu lang und detailliert sein kann, aber zu lang ist besser als zu kurz. Wenn Sie denken, Ihre README ist zu lang, ziehen Sie in Betracht, eine andere Form der Dokumentation zu verwenden, anstatt Informationen wegzulassen.
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
Lassen Sie die Leute wissen, was Ihr Projekt konkret kann. Geben Sie Kontext und fügen Sie einen Link zu Referenzen hinzu, die Besuchern möglicherweise nicht vertraut sind. Eine Liste von Funktionen oder ein Unterabschnitt „Hintergrund“ kann hier ebenfalls hinzugefügt werden. Wenn es Alternativen zu Ihrem Projekt gibt, ist dies ein guter Ort, um differenzierende Faktoren aufzulisten.
In manchen READMEs sehen Sie kleine Bilder, die Metadaten übermitteln, z. B. ob alle Tests für das Projekt bestanden werden. Sie können Shields verwenden, um solche Bilder zu Ihrer README hinzuzufügen. Viele Dienste haben auch Anleitungen zum Hinzufügen eines Badges.
Je nachdem, was Sie erstellen, kann es eine gute Idee sein, Screenshots oder sogar ein Video einzufügen (häufig sieht man GIFs anstelle von tatsächlichen Videos). Tools wie ttygif können helfen, aber schauen Sie sich Asciinema für eine anspruchsvollere Methode an.
In einem bestimmten Ökosystem gibt es möglicherweise eine gängige Methode zur Installation, z. B. mit Yarn, NuGet oder Homebrew. Bedenken Sie jedoch die Möglichkeit, dass der Leser Ihrer README ein Anfänger ist und mehr Anleitung wünscht. Die Auflistung spezifischer Schritte hilft, Unklarheiten zu beseitigen und ermöglicht es den Leuten, Ihr Projekt so schnell wie möglich zu nutzen. Wenn es nur in einem bestimmten Kontext läuft, wie einer bestimmten Programmiersprachenversion oder einem bestimmten Betriebssystem, oder Abhängigkeiten hat, die manuell installiert werden müssen, fügen Sie auch einen Unterabschnitt „Voraussetzungen“ hinzu.
Verwenden Sie großzügig Beispiele und zeigen Sie die erwartete Ausgabe, wenn möglich. Es ist hilfreich, das kleinste Beispiel der Verwendung einzubauen, das Sie demonstrieren können, während Sie Links zu anspruchsvolleren Beispielen bereitstellen, wenn diese zu lang sind, um sie sinnvoll in die README aufzunehmen.
Teilen Sie den Leuten mit, wo sie Hilfe bekommen können. Es kann jede Kombination aus Issue-Tracker, Chatraum, E-Mail-Adresse usw. sein.
Wenn Sie Ideen für zukünftige Versionen haben, ist es eine gute Idee, diese in der README aufzulisten.
Geben Sie an, ob Sie offen für Beiträge sind und welche Anforderungen Sie für deren Annahme haben.
Für Leute, die Änderungen an Ihrem Projekt vornehmen möchten, ist es hilfreich, eine Dokumentation darüber zu haben, wie sie loslegen können. Vielleicht gibt es ein Skript, das sie ausführen sollten, oder einige Umgebungsvariablen, die sie setzen müssen. Machen Sie diese Schritte explizit. Diese Anweisungen könnten auch für Ihr zukünftiges Ich nützlich sein.
Sie können auch Befehle zum Linten des Codes oder zum Ausführen von Tests dokumentieren. Diese Schritte helfen, eine hohe Codequalität sicherzustellen und die Wahrscheinlichkeit zu verringern, dass die Änderungen versehentlich etwas kaputt machen. Anweisungen zum Ausführen von Tests sind besonders hilfreich, wenn dies eine externe Einrichtung erfordert, wie das Starten eines Selenium-Servers zum Testen in einem Browser.
Zeigen Sie Ihre Wertschätzung für diejenigen, die zum Projekt beigetragen haben.
Geben Sie für Open-Source-Projekte an, wie es lizenziert ist.
Wenn Ihnen die Energie oder Zeit für Ihr Projekt ausgegangen ist, fügen Sie oben in der README einen Hinweis ein, dass die Entwicklung langsamer geworden oder vollständig gestoppt ist. Jemand könnte sich entscheiden, Ihr Projekt zu forken oder sich freiwillig als Betreuer oder Eigentümer zu melden, damit Ihr Projekt weitergeführt wird. Sie können auch explizit nach Betreuern suchen.