{"meta":{"title":"README-Datei erstellen","intro":"Generiere umfassende Infodateien für deine Projekte.","product":"GitHub Copilot","breadcrumbs":[{"href":"/de/enterprise-cloud@latest/copilot","title":"GitHub Copilot"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials","title":"Anleitungen"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials/customization-library","title":"Anpassungsbibliothek"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials/customization-library/prompt-files","title":"Befehlsdateien"},{"href":"/de/enterprise-cloud@latest/copilot/tutorials/customization-library/prompt-files/create-readme","title":"README-Datei erstellen"}],"documentType":"article"},"body":"# README-Datei erstellen\n\nGeneriere umfassende Infodateien für deine Projekte.\n\n> \\[!NOTE]\n>\n> * Copilot-Promptdateien befinden sich in der öffentliche Vorschau. Änderungen sind vorbehalten. Promptdateien sind nur in VS Code, Visual Studio und JetBrains-IDEs verfügbar. Siehe [Informationen zum Anpassen der GitHub Copilot-Antworten](/de/enterprise-cloud@latest/copilot/concepts/prompting/response-customization#about-prompt-files).\n> * Beispiele für von der Community bereitgestellte Promptdateien für bestimmte Sprachen und Szenarios findest du im Repository [Großartige GitHub Copilot-Anpassungen](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md).\n\nDiese Eingabeaufforderungsdatei erstellt professionelle, umfassende README-Dateien, indem sie die gesamte Projektstruktur und Codebasis analysiert.\n\n## Prompt für den README-Generator\n\n```text copy\n---\nagent: 'agent'\ndescription: 'Create a comprehensive README.md file for the project'\n---\n\n## Role\n\nYou're a senior software engineer with extensive experience in open source projects. You create appealing, informative, and easy-to-read README files.\n\n## Task\n\n1. Review the entire project workspace and codebase\n2. Create a comprehensive README.md file with these essential sections:\n   - **What the project does**: Clear project title and description\n   - **Why the project is useful**: Key features and benefits\n   - **How users can get started**: Installation/setup instructions with usage examples\n   - **Where users can get help**: Support resources and documentation links\n   - **Who maintains and contributes**: Maintainer information and contribution guidelines\n\n## Guidelines\n\n### Content and Structure\n\n- Focus only on information necessary for developers to get started using and contributing to the project\n- Use clear, concise language and keep it scannable with good headings\n- Include relevant code examples and usage snippets\n- Add badges for build status, version, license if appropriate\n- Keep content under 500 KiB (GitHub truncates beyond this)\n\n### Technical Requirements\n\n- Use GitHub Flavored Markdown\n- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository\n- Ensure all links work when the repository is cloned\n- Use proper heading structure to enable GitHub's auto-generated table of contents\n\n### What NOT to include\n\nDon't include:\n- Detailed API documentation (link to separate docs instead)\n- Extensive troubleshooting guides (use wikis or separate documentation)\n- License text (reference separate LICENSE file)\n- Detailed contribution guidelines (reference separate CONTRIBUTING.md file)\n\nAnalyze the project structure, dependencies, and code to make the README accurate, helpful, and focused on getting users productive quickly.\n```\n\n## Anleitung zur Verwendung dieser Promptdatei\n\n1. Speichern Sie den obigen Inhalt als `create-readme.prompt.md` im Ordner `.github/prompts` Ihres Repositorys.\n2. Zeige in Visual Studio Code die Copilot-Chat-Ansicht an, und gib `/create-readme` ein.\n\n## Weitere Informationen\n\n* [Verwenden von Promptdateien in Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/prompt-files) in der Visual Studio Code-Dokumentation: Informationen zum Erstellen und Verwenden von Promptdateien\n* [Informationen zum Anpassen der GitHub Copilot-Antworten](/de/enterprise-cloud@latest/copilot/concepts/response-customization): Übersicht über die Anpassung von Antworten in GitHub Copilot\n* [Großartige GitHub Copilot-Anpassungen](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md): Repository der durch die Community bereitgestellten benutzerdefinierten Promptdateien und weiterer Anpassungen für bestimmte Sprachen und Szenarios"}