A>_ASCIIForge
DE
Anleitung

ASCII-Art für GitHub README

ASCII-Banner machen README-Abschnitte ubersichtlicher, wenn sie kompakt bleiben.

Deine README erstellen

Nutze das Banner oben, ergänze Projektdetails und lade eine Markdown-Datei herunter.

Mit einem vollständigen Beispiel starten

Wähle ein einfaches Python-Projekt, eine Bibliothek oder ein Kommandozeilenwerkzeug. Passe Beispieltexte und Befehle an dein Projekt an; dein Banner bleibt erhalten.

Einfaches Projekt

Eine kurze Vorstellung, ein funktionierender Befehl und Hinweise zum Mitmachen.

Python-Bibliothek

Ein kleines wiederverwendbares Modul mit einem Importbeispiel.

Kommandozeilenwerkzeug

Ein Terminalbefehl mit Eingabedatei und erwartetem Ergebnis.

Lauffähige Beispiele herunterladen (ZIP, Englisch)

README-Vorschau

README-Vorschau
Vollständiges Markdown
Diese Felder bleiben auf dieser Seite und fehlen im Banner-Link. Installation und Verwendung werden als Code kopiert, Beschreibung und Mitwirkung als einfacher Text.
ASCII-Überschriften lassen eine README hervorstechen
Eine schlichte README beginnt mit einer Textzeile. Eine großartige beginnt mit einem Banner. ASCII-Art gibt deinem Projekt eine wiedererkennbare Überschrift, Abschnittstrenner und Status-Badges, ohne Bilddateien ins Repository zu legen — es ist nur Text, lädt also sofort und funktioniert in jedem Git-Viewer.
Nutze immer einen Codeblock
GitHubs Markdown zeigt normalen Text proportional, was die ASCII-Ausrichtung zerstört. Packe die Kunst in einen Codeblock, damit sie in Monospace dargestellt wird:
```
+------------+
| MY PROJECT |
+------------+
```
Nutze einen Block mit drei Backticks ohne Sprach-Tag, damit kein Syntax-Highlighter deine Kunst umfärbt.
Wähle die richtige Breite
Gemessen mit deinem vollständigen Text, der Großschreibung und dem Rahmen. Prüfe das Ergebnis am Zielgerät.
Wo du es einsetzt
  • Das Projekt-Titelbanner ganz oben.
  • Abschnittstrenner über Installation, Nutzung und Lizenz.
  • Einfache Statusmarker wie == BUILD PASSING ==.
  • Ein ASCII-Logo aus deinem App-Icon erzeugt.
Halte es barrierefrei
Screenreader lesen ASCII-Art Zeichen für Zeichen, verstecke also keine wichtigen Infos in der Kunst. Behalte eine normale Textüberschrift neben dem Banner, damit die Seite auch ohne Sinn ergibt.
README-Banner erzeugen