今回やること
この記事では、GitHubに置くプロジェクトの説明として README.md を書きます。
READMEは、作ったものを他人と未来の自分に説明するための入口です。
Step 1: README.mdを作る
プロジェクトフォルダに README.md を作ります。
touch README.md
PowerShellでは次を使えます。
New-Item README.md
Step 2: 最小構成を書く
まずは、次の形で十分です。
# プロジェクト名
このプロジェクトは、HTML/CSS/JavaScriptの学習用に作成したものです。
## 作った理由
基本的なWebページ作成の流れを練習するためです。
## 使用技術
- HTML
- CSS
- JavaScript
## 使い方
`index.html` をブラウザで開きます。
Step 3: 見出しと箇条書きを使う
Markdownでは、# で見出しを作ります。
# 大見出し
## 中見出し
### 小見出し
箇条書きは - を使います。
- HTML
- CSS
- JavaScript
Step 4: コードやコマンドを書く
短いコードはバッククォートで囲みます。
`index.html`
複数行のコードは fenced code block にします。
```bash
npm run dev
```
言語名を付けると読みやすくなります。
Step 5: 学習記録を書く
READMEには、完成品の説明だけでなく学習記録も書けます。
## 学んだこと
- ファイルを分けて管理する方法
- CSSをHTMLに読み込む方法
- JavaScriptでクリックイベントを書く方法
## 次に改善したいこと
- スマホ表示を整える
- 入力フォームを追加する
- GitHub Pagesで公開する
ポイント: READMEは上手な文章を書く場所ではなく、作ったもの、使い方、学んだことを整理する場所です。
よくあるエラー
| 困る状態 | よくある原因 | 確認する場所 |
|---|---|---|
| GitHubで表示されない | ファイル名が違う | README.md |
| 見出しにならない | # の後に半角スペースがない | Markdown記法 |
| コードが崩れる | バッククォートの閉じ忘れ | code block |
次にやること
エラー文の読み方と検索方法 で、詰まった時の調べ方を練習します。
まとめ
READMEは、プロジェクトの入口です。プロジェクト名、概要、作った理由、使用技術、使い方、学んだことを書くと、成果物として伝わりやすくなります。
参考リソース
← 一覧に戻るPR
PR
