Eine kurze Beschreibung: Referenzen, Markdown, Symbole, um die Datei README.md viel, viel cooler zu machen.
Logo oder Banner | Projektname | Beschreibung | Index | Über die README | Badges | Visuals und Screenshots | Techniker | Installation | Verwendung | Projektstatus | Beiträge | Autoren und Bestätigung | Referenzen | Lizenz
Jedes Projekt ist anders. Überlegen Sie also, welcher dieser Abschnitte für Sie gilt. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open Source-Projekte. Denken Sie auch daran, dass eine README-Datei zwar zu lang und detailliert sein kann, zu lang jedoch besser als zu kurz ist.
Wenn Sie der Meinung sind, dass Ihre README-Datei zu lang ist, sollten Sie eine andere Form der Dokumentation verwenden, anstatt Informationen auszuschneiden.
Markdown ist ein Tool zur Konvertierung von Text in HTML. Sie schreiben mit einfachem, leicht lesbarem und leicht zu schreibendem Text und wandeln ihn dann in gültigen HTML-Code um.
Markdown wurde von John Gruber und Aaron Swartz erstellt und ihr Quellcode wurde in Perl geschrieben. Dies ist die offizielle Website [hier] (https://daringfireball.net/projects/markdown/)
Sie können MarkDown-Indizes in VS Code anzeigen und erstellen, indem Sie eine Erweiterung hinzufügen:
| Verknüpfungen | Funktionalität | |: ---------- | ------ | | cmd-k v oder ctrl-k | Öffnen Sie die Vorschau zur Seite | | cmd-shift-v oder ctrl-shift-v | Vorschau öffnen |
Darüber hinaus wird die Erstellung von Tabellen durch Websites wie:
Status: Optional
Wenn Ihr Projekt bereits ein Logo hat, fügen Sie es der README-Datei hinzu. Es kann auch ein Banner sein. Sie können mit Canva ein Logo oder Banner erstellen.
Das Logo oder Banner ersetzt möglicherweise den Titel, nicht jedoch die Beschreibung des Projekts. Das Gute daran, den Titel und die Beschreibung im Text zu behalten, ist, dass es bei Github SEO hilft. Google hilft dabei, Ihr Projekt auf den ersten Seiten der Suche besser zu indizieren und gibt eine Zusammenfassung über Ihr Projekt.
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
Lassen Sie die Leute wissen, was Ihr Projekt konkret tun kann. Geben Sie den Kontext an und fügen Sie einen Link zu Referenzbesuchern hinzu, mit denen Sie möglicherweise nicht vertraut sind. Hier kann auch eine Liste der Funktionen oder ein Unterabschnitt Hintergrund hinzugefügt werden. Wenn es Alternativen zu Ihrem Projekt gibt, ist dies ein guter Ort, um differenzierende Faktoren aufzulisten.
Jedes Projekt ist anders. Überlegen Sie also, welcher dieser Abschnitte für Sie gilt. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open Source-Projekte. Denken Sie auch daran, dass eine README-Datei zwar zu lang und detailliert sein kann, zu lang jedoch besser als zu kurz ist.
Wenn Sie der Meinung sind, dass Ihre README-Datei zu lang ist, sollten Sie eine andere Form der Dokumentation verwenden, anstatt Informationen auszuschneiden.
Markdown ist ein Tool zur Konvertierung von Text in HTML. Sie schreiben mit einfachem, leicht lesbarem und leicht zu schreibendem Text und wandeln ihn dann in gültigen HTML-Code um.
Markdown wurde von John Gruber und Aaron Swartz erstellt und ihr Quellcode wurde in Perl geschrieben. Dies ist die offizielle Website [hier] (https://daringfireball.net/projects/markdown/)
Sie können MarkDown in VS Code anzeigen, indem Sie eine Erweiterung hinzufügen:
Sie können MarkDown in VS Code anzeigen, indem Sie eine Erweiterung hinzufügen:
| Verknüpfungen | Funktionalität |
|---|---|
| cmd-k v or ctrl-k | Open preview to the Side |
| cmd-shift-v or ctrl-shift-v | Open preview |
In einigen READMEs werden möglicherweise kleine Bilder angezeigt, die Metadaten enthalten, z. B. ob alle Tests für das Projekt bestanden wurden oder nicht. Sie können Shields verwenden, um einige zu Ihrer README hinzuzufügen. Viele Dienste haben auch Anweisungen zum Hinzufügen eines Ausweises.
Je nachdem, was Sie machen, kann es eine gute Idee sein, Screenshots oder sogar ein Video einzuschließen (häufig werden GIFs anstelle von tatsächlichen Videos angezeigt). Tools wie ttygif können helfen, aber schauen Sie sich Asciinema für eine ausgefeiltere Methode an.
| Tag | Beschreibung | Technologien |
|---|---|---|
| 03/08 | Beschleunigung Ihrer Evolution |   |
| 05/08 | Die Wahl des Stapels |   |
| 07/08 | Die Extrameile |
- Erstellen einer Zielseitenstruktur
- Landing Page stilisieren
- Authentifizierung
- Anmelden / Abmelden
- Angemeldet bleiben - Token
Innerhalb eines bestimmten Ökosystems gibt es möglicherweise eine übliche Methode zur Installation von Dingen, z. B. die Verwendung von Garn, NuGet oder Homebrew. Berücksichtigen Sie jedoch die Möglichkeit, dass jeder, der Ihre README-Datei liest, ein Anfänger ist und weitere Anleitungen wünscht. Das Auflisten bestimmter Schritte hilft dabei, Unklarheiten zu beseitigen, und bringt die Benutzer dazu, Ihr Projekt so schnell wie möglich zu verwenden. Wenn es nur in einem bestimmten Kontext wie einer bestimmten Programmiersprachenversion oder einem bestimmten Betriebssystem ausgeführt wird oder Abhängigkeiten aufweist, die manuell installiert werden müssen, fügen Sie auch einen Unterabschnitt Anforderungen hinzu.
| Technologie | Version | Befehl zum Installieren |
|---|---|---|
| NodeJS | 12.18.2 | brew install node |
| Yarn | 1.17.3 | npm install -g yarn |
| Expo | 3.23.1 | yarn add global expo-cli |
Verwenden Sie Beispiele großzügig und zeigen Sie die erwartete Ausgabe, wenn Sie können. Es ist hilfreich, das kleinste Anwendungsbeispiel, das Sie demonstrieren können, inline zu haben und Links zu komplexeren Beispielen bereitzustellen, wenn diese zu lang sind, um in die README-Datei aufgenommen zu werden.
Strikethrough Strikethrough (when enable html tag decode.)
Italic Italic
Emphasis Emphasis
Emphasis Italic Emphasis Italic
Superscript: X2，Subscript: O2
$ npm install marked
Indented 4 spaces, like <pre> (Preformatted Text).
<?php
echo "Hello world!";
?>
Code Blocks (Preformatted text):
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
<!DOCTYPE html>
<html>
<head>
<mate charest="utf-8" />
<title>Hello world!</title>
</head>
<body>
<h1>Hello world!</h1>
</body>
</html>© & ¨ ™ ¡ £ & < > ¥ € ® ± ¶ § ¦ ¯ « ·
X² Y³ ¾ ¼ × ÷ »
18ºC " '
*literal asterisks*
Klonen Sie zunächst das Repository für Ihre Umgebung:
> git clone https://github.com/shyoutarou/REPO_NAME.git Geben Sie dann das geklonte Repository und das Verzeichnis ein, das dem zu testenden Repository (Web, Server) entspricht. Geben Sie kurz darauf für jedes Verzeichnis die folgenden Befehle in Ihr Terminal ein:
# Entra no diretório "REPO_NAME"
> cd ./REPO_NAME
# Instala todas as dependências
> yarn install or npm installWenn Ihnen die Energie oder Zeit für Ihr Projekt ausgeht, schreiben Sie oben in die README-Datei, dass sich die Entwicklung verlangsamt oder vollständig gestoppt hat. Jemand kann sich dafür entscheiden, Ihr Projekt zu teilen oder sich freiwillig als Betreuer oder Eigentümer zu melden, damit Ihr Projekt weiterlaufen kann. Sie können auch eine explizite Anfrage für Betreuer stellen.
Bieten Sie Menschen eine Kontaktform. Dies kann eine beliebige Kombination von Kontakten, einem Chatroom, einer E-Mail-Adresse usw. sein.
Sie können ein neues Problem mit Titel und Beschreibung im Proffy-Repository registrieren.
Wenn Sie bereits eine Lösung für Ihr Problem gefunden haben, würde ich gerne Ihre Pull-Anfrage überprüfen!
Wenn Sie Ideen für zukünftige Releases haben, ist es eine gute Idee, diese in der README-Liste aufzulisten. Geben Sie an, ob Sie für Beiträge offen sind und welche Anforderungen Sie an die Annahme dieser Beiträge stellen.
Für Personen, die Änderungen an Ihrem Projekt vornehmen möchten, ist es hilfreich, eine Dokumentation zu den ersten Schritten zu haben. Vielleicht gibt es ein Skript, das sie ausführen sollten, oder einige Umgebungsvariablen, die sie festlegen müssen. Machen Sie diese Schritte explizit. Diese Anweisungen könnten auch für Ihr zukünftiges Selbst nützlich sein.
Sie können auch Befehle dokumentieren, um den Code zu fusseln oder Tests auszuführen. Diese Schritte tragen dazu bei, eine hohe Codequalität sicherzustellen und die Wahrscheinlichkeit zu verringern, dass die Änderungen versehentlich etwas beschädigen. Anweisungen zum Ausführen von Tests sind besonders hilfreich, wenn ein externes Setup erforderlich ist, z. B. das Starten eines Selenium-Servers zum Testen in einem Browser.
Befolgen Sie die folgenden Schritte, um einen Beitrag zu leisten:
-
Fork das Projekt (https://github.com/shyoutarou/REPO_NAME.git)
-
Klonen Sie Ihre Fork auf Ihren Computer (
git clone https://github.com/user_name/REPO_NAME.git) -
Erstellen Sie einen branch, um Ihre Änderung durchzuführen (
git checkout -b feature/name_new_feature) -
Fügen Sie Ihre Änderungen hinzu und commit (
git commit -m "Descreva sua modificação") -
Push (
git push origin feature/name_new_feature) -
Erstellen Sie eine neue Pull Request
-
Okay, jetzt warte einfach auf die Analyse
Zeigen Sie denen, die zum Projekt beigetragen haben, Ihre Wertschätzung.
| Eu |
|---|
|
-
Banner
-
MarkDown
-
Badges
-
GIFS
-
Guias
Wenn Ihr Projekt Open Source ist, ist es wichtig, eine Lizenz beizufügen.
Das 2020 veröffentlichte Projekt unter der Lizenz [MIT] (./ LIZENZ) ❤️
Hergestellt mit ❤️ von Shyoutarou
Gefallen? Hinterlasse einen kleinen Stern, um das Projekt zu unterstützen ⭐