# README を作成する

プロジェクトの包括的な README ファイルを生成します。

> \[!NOTE]
>
> * Copilot プロンプト ファイルは パブリック プレビュー 段階であり、変更される可能性があります。 プロンプト ファイルは、VS Code、Visual Studio、および JetBrains IDE でのみ使用できます。「[GitHub Copilotの応答をカスタマイズする方法](/ja/copilot/concepts/prompting/response-customization#about-prompt-files)」を参照してください。
> * 特定の言語とシナリオ向けの、コミュニティに投稿されたプロンプト ファイルの例については、[Awesome GitHub Copilot Customizations](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md) リポジトリを参照してください。

このプロンプト ファイルは、project構造とコードベース全体を分析することで、プロフェッショナルで包括的な README ファイルを作成します。

## README ジェネレーター プロンプト

```text copy
---
agent: 'agent'
description: 'Create a comprehensive README.md file for the project'
---

## Role

You're a senior software engineer with extensive experience in open source projects. You create appealing, informative, and easy-to-read README files.

## Task

1. Review the entire project workspace and codebase
2. Create a comprehensive README.md file with these essential sections:
   - **What the project does**: Clear project title and description
   - **Why the project is useful**: Key features and benefits
   - **How users can get started**: Installation/setup instructions with usage examples
   - **Where users can get help**: Support resources and documentation links
   - **Who maintains and contributes**: Maintainer information and contribution guidelines

## Guidelines

### Content and Structure

- Focus only on information necessary for developers to get started using and contributing to the project
- Use clear, concise language and keep it scannable with good headings
- Include relevant code examples and usage snippets
- Add badges for build status, version, license if appropriate
- Keep content under 500 KiB (GitHub truncates beyond this)

### Technical Requirements

- Use GitHub Flavored Markdown
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
- Ensure all links work when the repository is cloned
- Use proper heading structure to enable GitHub's auto-generated table of contents

### What NOT to include

Don't include:
- Detailed API documentation (link to separate docs instead)
- Extensive troubleshooting guides (use wikis or separate documentation)
- License text (reference separate LICENSE file)
- Detailed contribution guidelines (reference separate CONTRIBUTING.md file)

Analyze the project structure, dependencies, and code to make the README accurate, helpful, and focused on getting users productive quickly.
```

## このプロンプト ファイルの使用方法

1. 上記の内容を `create-readme.prompt.md` としてリポジトリの `.github/prompts` フォルダーに保存します。
2. Visual Studio Code で コパイロットチャット ビューを表示し、「`/create-readme`」と入力します。

## 参考資料

* Visual Studio Code ドキュメントの「[Visual Studio Code でプロンプト ファイルを使う](https://code.visualstudio.com/docs/copilot/customization/prompt-files)」- プロンプト ファイルの作成と使用の方法に関する情報
* [GitHub Copilotの応答をカスタマイズする方法](/ja/copilot/concepts/response-customization) - GitHub Copilot での応答カスタマイズの概要
* [優れた GitHub Copilot カスタマイズ](https://github.com/github/awesome-copilot/blob/main/docs/README.prompts.md) - コミュニティに投稿されたカスタム プロンプト ファイルや、特定の言語やシナリオ向けのその他のカスタマイズのリポジトリ