You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
81
+
82
+
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.
83
+
84
+
## Projektname
74
85
75
86
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
76
87
@@ -80,9 +91,35 @@ Darüber hinaus wird die Erstellung von Tabellen durch Websites wie:
80
91
81
92
### 🧐 Motivation
82
93
83
-
Motivationsbeschreibung
94
+
Motivationsbeschreibung
95
+
------------------------
96
+
97
+
## ❔ Über die README
98
+
99
+
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.
84
100
85
-
## Abzeichen
101
+
Wenn Sie der Meinung sind, dass Ihre README-Datei zu lang ist, sollten Sie eine andere Form der Dokumentation verwenden, anstatt Informationen auszuschneiden.
102
+
103
+
### ⌨️ Was ist Markdown?
104
+
105
+
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.
106
+
107
+
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/)
108
+
109
+
Sie können MarkDown in VS Code anzeigen, indem Sie eine Erweiterung hinzufügen:
110
+
111
+
Sie können MarkDown in VS Code anzeigen, indem Sie eine Erweiterung hinzufügen:
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.
88
125
@@ -91,7 +128,6 @@ Darüber hinaus wird die Erstellung von Tabellen durch Websites wie:
91
128
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.
@@ -224,7 +260,11 @@ Geben Sie dann das geklonte Repository und das Verzeichnis ein, das dem zu teste
224
260
225
261
## 🤝 Beiträge
226
262
227
-
Wenn Sie Ideen für zukünftige Releases haben, ist es eine gute Idee, diese in der README-Liste aufzulisten. Mitwirken 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.
263
+
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.
264
+
265
+
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.
266
+
267
+
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.
228
268
229
269
-------------
230
270
@@ -256,7 +296,7 @@ Befolgen Sie die folgenden Schritte, um einen Beitrag zu leisten:
@@ -96,6 +98,31 @@ Let people know what your project can do specifically. Provide context and add a
96
98
Status: Optional
97
99
98
100
Motivation Description
101
+
------------------------
102
+
103
+
## ❔ About the README
104
+
105
+
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short.
106
+
107
+
If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. This is a suggested structure, each one can do according to the needs of the project. We will now cover each of the structure's topics and other additional points.
108
+
109
+
### ⌨️ What´s Markdown?
110
+
111
+
Markdown is a text to HTML conversion tool. You write using simple, easy-to-read and easy-to-write text and then it is transformed into valid HTML.
112
+
113
+
Markdown was created by John Gruber and Aaron Swartz and their source code was written in Perl. This is the official website [here](https://daringfireball.net/projects/markdown/)
114
+
115
+
You can view MarkDown within VS Code by adding an extension:
116
+
117
+
You can view MarkDown within VS Code by adding an extension:
@@ -112,7 +139,6 @@ Depending on what you are making, it can be a good idea to include screenshots o
112
139
The safest way to keep the files is to create a folder of screenshots, github, assets, resources or whatever name you want and leave the files in it. If you use an image or gif CDN it may work but you risk breaking the link someday.
@@ -258,8 +284,6 @@ Offer people a form of contact. It can be any combination of contacts, a chat r
258
284
Status: Required
259
285
260
286
If you have ideas for releases in the future, it is a good idea to list them in the README.
261
-
Contributing
262
-
263
287
State if you are open to contributions and what your requirements are for accepting them.
264
288
265
289
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
@@ -300,7 +324,7 @@ Show your appreciation to those who have contributed to the project.
@@ -96,6 +98,31 @@ Deixe as pessoas saberem o que seu projeto pode fazer especificamente. Forneça
96
98
Status: Opcional
97
99
98
100
Descrição do Motivo
101
+
------------------------
102
+
103
+
## ❔ Sobre o README
104
+
105
+
Cada projeto é diferente, portanto, considere quais dessas seções se aplicam ao seu. As seções usadas no modelo são sugestões para a maioria dos projetos de código aberto. Também tenha em mente que, embora um README possa ser muito longo e detalhado, muito longo é melhor do que muito curto.
106
+
107
+
Se você acha que seu README é muito longo, considere utilizar outra forma de documentação em vez de cortar as informações. Essa é uma sugestão de estrutura, cada um pode fazer conforme a necessidade do projeto. Vamos agora cobrir cada um dos tópicos da estrutura e outros pontos adicionais.
108
+
109
+
### ⌨️ O que é Markdown?
110
+
111
+
O Markdown é uma ferramenta de conversão de texto em HTML. Você escreve usando texto simples de fácil leitura e fácil escrita e depois é transformado em um HTML válido.
112
+
113
+
Markdown foi criado por John Gruber e Aaron Swartz e seu código fonte foi escrito em Perl. O site oficial é esse [aqui](https://daringfireball.net/projects/markdown/)
0 commit comments