{"meta":{"title":"Создание README","intro":"Создайте комплексные файлы README для проектов.","product":"GitHub Copilot","breadcrumbs":[{"href":"/ru/copilot","title":"GitHub Copilot"},{"href":"/ru/copilot/tutorials","title":"Учебники"},{"href":"/ru/copilot/tutorials/customization-library","title":"Библиотека настройки"},{"href":"/ru/copilot/tutorials/customization-library/prompt-files","title":"Запрос файлов"},{"href":"/ru/copilot/tutorials/customization-library/prompt-files/create-readme","title":"Создание README"}],"documentType":"article"},"body":"# Создание README\n\nСоздайте комплексные файлы README для проектов.\n\n> \\[!NOTE]\n>\n> * Файлы запроса Copilot находятся в public preview и подвергаются изменению. Файлы запросов доступны только в IDE VS Code, Visual Studio и JetBrains. Смотрите [АВТОЗАГОЛОВОК.](/ru/copilot/concepts/prompting/response-customization#about-prompt-files)\n> * Примеры файлов запросов для определенных языков и сценариев в сообществе см. в [репозитории GitHub Copilot Customizations](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md) .\n\nЭтот файл с подсказками создаёт профессиональные, комплексные README-файлы, анализируя всю структуру и кодовую базу вашего project.\n\n## Запрос генератора README\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## Использование этого файла запроса\n\n1. Сохраните вышеуказанное содержимое как `create-readme.prompt.md` в папке `.github/prompts` вашего репозитория.\n2. В Visual Studio Codeотобразите представление Копилот Чат и введите `/create-readme`.\n\nданных, многократно используемых.copilot.prompt-files-further-reading %}"}