READMEというのは、GitHub等で公開されるソフトウェア(リポジトリ)の説明書きのことです。
そのリポジトリーがどういった趣旨の物なのか、しっかりと説明しましょう。
readmeに記載する物
- プロジェクトのタイトル
- プロジェクトの概要説明
- プロジェクトのURL
- サイトのスクリーンショット画像
- 使用言語
- 使用している機能
- 目次
- 過去の経歴など
https://github.com/0918nobita/Portfolio
マークダウン記法(md)
githubのreadmeはmd記法なので、md記法を使って書いていきましょう。
qiita.com