README Generator

Kommerzielle Nutzung OK 380+ Modelle Kein Wasserzeichen Keine Anmeldung erforderlich
Modell:
+ GPT-5, Claude, Gemini
Beschreiben Sie Ihr Projekt (oder paste package.json / pyproject.toml / Cargo.toml) und erhalten Sie wieder eine polierte README.md — Titel, Schilde, installieren, quickstart, Funktionen, Beitrag, Lizenz. Wählen Sie Ihren Projekttyp, Länge und Ton.
Einschließlich:
Beschreiben Sie Ihr Projekt.
README.md

        
Erweiterte Optionen
Ergebnis
Die Tokens sind knapp. Erhalten Sie mehr Token
Willst du bessere Ergebnisse? Premium-Modelle (GPT-5, Claude, Gemini) liefern eine höhere Qualität. Pläne anzeigen

❤️ Love this tool? Share it!

Sign up um einen Verweis zu erhalten und 25.000 Token pro Freund zu verdienen.

Willst du mehr? Melde dich kostenlos an für 30K Tokens/Tag + 10K Bonus
Kostenlos anmelden

Ihre Anfrage bearbeiten...

Generieren Sie Projekt README-Dateien mit kostenloser KI. Professionelle Dokumentation in Sekunden.

Verwendung README Generator

1
Geben Sie Ihre Eingabe ein

Geben Sie Text ein, laden Sie eine Datei hoch oder beschreiben Sie, was Sie wollen.

2
Klicken Sie auf Generieren

Unsere KI verarbeitet Ihre Anfrage in Sekundenschnelle mit den besten Open-Source-Modellen.

3
Herunterladen & Teilen

Downloaden, kopieren oder teilen Sie Ihr Ergebnis. Kostenlos für den persönlichen und kommerziellen Gebrauch.

Verwenden Sie dieses Tool über API

Automatisieren Sie dieses Tool aus Ihrem eigenen Code. OpenAI-kompatible REST-Endpunkt, Bearer-Token-Auth, kein zusätzliches SDK erforderlich. Tokenkosten entsprechen der Web-Schnittstelle.

curl -X POST https://api.free.ai/v1/chat/ \
  -H "Authorization: Bearer sk-free-..." \
  -H "Content-Type: application/json" \
  -d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'

README Generator — FAQ

Beschreiben Sie Ihr Projekt in 2-3 Sätzen (oder paste package.json / pyproject.toml / Cargo.toml) und erhalten Sie wieder eine polierte README.md — Titel, Schildabzeichen, Inhaltsverzeichnis, installieren, quickstart, Features, Nutzung, optional beitragen / Lizenz / FAQ Abschnitte. Wählen Sie Projekttyp (Bibliothek / CLI / Webapp / API / mobile / Plugin / Datensatz / Papier / Vorlage), Länge (minimal → erschöpfend), und Ton (professionell / freundlich / technische / Marketing / akademischen).

readme-so und makeareadme.com sind Formular-Fill-Vorlagen — Sie manuell tick-Boxen und erhalten Stock-Abschnitte. Free.ai ist generativ — es schreibt Kopie spezifisch für Ihr Projekt, unter Berufung auf vernünftige Installationsbefehle / API-Form / Ton aus Ihrer Beschreibung. Copilot ($10/mo) ist inline-IDE und erzeugt README Text Absatz für Absatz, wie Sie eingeben; Free.ai produziert die gesamte Datei in einem Schuss. Verwenden Sie readme-so für reine Struktur; Free.ai, wenn Sie tatsächliche Kopie wollen.

Die Systemaufforderung verbietet ausdrücklich das Erfinden von Funktionen. Wenn die Beschreibung vage ist, fügt das Modell "TODO" Platzhalter ein. Lesen Sie immer die erzeugte README und entfernen Sie TODOs (oder ersetzen Sie durch aktuelle Inhalte) vor der Veröffentlichung – behandeln Sie die Ausgabe als polierten ersten Entwurf, nicht eine schiffsfertige Datei.

Ja, wenn aktiviert — eine Reihe von 3-6 Schilden (Build, Version, Lizenz, Downloads, Abdeckung) mit Platzhalter-URLs, die Sie auf Ihre repo anpassen. Das Modell wählt sinnvolle Voreinstellungen basierend auf Projekttyp (Bibliothek bekommt npm-Version oder pypi-Version; CLI bekommt install count; webapp bekommt uptime).

Minimal (10 Linien) für interne Versorgungsunternehmen niemand entdecken. Standard (~80 Linien) für die meisten Open-Source-Projekte — trifft den süßen Fleck der Auffindbarkeit ohne Wände des Textes. Detaillierte (~200 Linien) für Projekte, die Sie aktiv vermarkten. Erschöpfend (docs-style, 300 Linien) wenn die README Ihre primäre Docs-Site ist.

Ja — wählen Sie "Marketing" Ton. Sie erhalten eine starke Schlagzeile, Benefit-led Kopie, sozial-sichere Platzhalter, stärkere CTAs. Die Abschnitte bleiben präzise (keine erfundenen Funktionen) aber die Prosa ist Pitch-Stil. Gut für SaaS-Start Repos, Portfolio-Projekte, Produkt-Hunt-Stil Releases.

Ja - wählen Sie "Academic" Ton. Die README enthält einen "Citation" Abschnitt mit einer BibTeX-Vorlage und eine Anfrage-wenn-verwendete Zeile, plus Methoden und Reproduzierbarkeitsfelder. Gut für Forschungspapier Repos und Modell / Datensatz Releases.

Ja — das Ergebnisfeld hat Markdown/Preview-Schaltflächen. Vorschau gibt Client-Seite mit einer GitHub-geflochtenen Untergruppe (Positionen, fett/italienisch, Codeblöcke, Inline-Code, Listen, Links) wieder. Nicht so poliert wie GitHub selbst – machen Sie immer einen finalen Test, indem Sie auf eine Repo drücken.

Der Standardgenerator nimmt ein Einzelprojekt README an. Für ein Monorepo root README beschreiben Sie das Repo als Monorepo in Ihrer Eingabe ("enthält 3 Pakete: foo, bar, baz") — das Modell fügt eine Pakettabelle hinzu und überspringt die Installationsanweisungen (da die Installation pro Paket erfolgt).

Qwen 3 Coder (frei, Standard) verarbeitet 95% der READMEs gut. Qwen 2.5 7B ist etwas schneller, aber weniger poliert in Marketing-Ton. Premium Claude Sonnet 4 ist deutlich besser in Marketing-Ton-Kopie und erschöpfend Länge READMEs - wert die bezahlten Token für Ihre Landing-Seite Repo.

Die Beschreibung wird an das Modell gesendet, verarbeitet und verworfen. Nicht gespeichert, nicht für das Training verwendet. Für maximale Privatsphäre wählen Qwen 3 Coder — selbst auf Free.ai GPUs gehostet.

Ja — POST zu /v1/chat/ mit der README-Systemaufforderung (Typ + Länge + Ton + Abschnittsflaggen) und der Projektbeschreibung als Benutzernachricht. Nützlich zur Automatisierung der README-Generierung während des Projektgerüsts. Siehe /api/.

Melde dich kostenlos an für 30.000 Token

Kostenloses Konto erstellen

Keine Kreditkarte erforderlich

Wie würden Sie dieses Tool bewerten?

5.0/5 from 1 rating

Love this tool? Share it!