---
name: README update skill
description: Skill to update and improve README.md. This skill is usefull for adjusting README to latest source code contents.
---
# スキルの目的
このスキルは、リポジトリのREADME.mdを最新のソースコードの内容に基づいて更新し、改善することを目的としています。

# README.mdの構成
## 全体構成
README.mdは、以下のセクションで構成されるようにする必要があります。

1. プロジェクトの概要
1. 使用方法
1. 開発方法
1. ライセンス情報

## 各セクションの詳細
### プロジェクトの概要
このプロジェクト中のアプリケーションが何をするものなのか、どのような目的で作成されたのかについて簡潔に記載してください。

### 使用方法
このセクションには、このアプリケーションにおいてユーザーが設定をどのように行うかについて具体的な手順を記載してください。
その際、環境変数による設定をサポートしている場合には、環境変数の一覧とその説明、デフォルト値を表形式で記載してください。

### 開発方法
ローカル開発環境のセットアップ方法について記載してください。
devcontaienrを利用している場合には、具体的なdevcontainerの起動コマンドを含めて説明してください。

### ライセンス情報
このセクションには、プロジェクトのライセンスに関する情報を記載してください。
特にライセンスが設定されていない場合は、その旨を明記してください。

# README.mdを更新する上での原則
READMEを更新する際には、以下に注意してください。

* 必ず最新のコードやリポジトリの内容に基づいて情報を更新してください。
* 不要な情報や古くなった情報は必ず削除してください。
* 上記のセクション構成には必ず従ってください。
* 誤字脱字や文法の誤りがないかを確認してください。
* 文章は平易な日本語で記載して下さい。