[GitHub 100日チャレンジ] Day 13 - README.mdの基本

READMEの役割

README.mdは、Repositoryを開いた人が最初に読む説明書です。何をするプロジェクトなのか、どう使うのか、どこを見ればよいのかを伝えます。

コードがまだ少なくても、READMEがあるだけでプロジェクトの意図が伝わりやすくなります。

最低限入れたい項目

• プロジェクト名
• 概要
• 使い方
• 学習目的
• 今後やりたいこと

Markdownの基本

# Project name

## Overview

This is my GitHub learning project.

## Usage

Open the files and read the notes.

見出し、段落、箇条書きを使うだけでも十分に読みやすくなります。

今日のゴール

自分のRepositoryにREADME.mdを作り、プロジェクト名と概要を書きましょう。