README を作成する

GitHub の概念の紹介

Jasmin Ludolf

Content Developer, DataCamp

READMEを編集する

サッカー分析リポジトリのビュー

GitHub の概念の紹介

READMEを編集する

READMEファイルが強調表示されたサッカー分析リポジトリの表示

GitHub の概念の紹介

READMEを編集する

READMEファイルを編集するための鉛筆アイコンが強調表示された、サッカー分析リポジトリの表示

GitHub の概念の紹介

マークダウン

READMEファイルのビュー

GitHub の概念の紹介

編集 vs. プレビュー

READMEファイルの表示。編集タブとプレビュータブが強調表示されている

GitHub の概念の紹介

見出し

マークダウンファイルの編集画面で、最大見出しの記法が表示されている

マークダウンファイルのプレビュー画面で、最大見出しが表示されている

GitHub の概念の紹介

見出し

マークダウンファイルの編集画面で、6 種類すべての見出しの記法が表示されている

マークダウンファイルのプレビュー画面で、6 種類すべての見出しが表示されている

GitHub の概念の紹介

見出し

マークダウンファイルの編集画面で、6 種類すべての見出しの記法が表示されている]

6種類すべての見出しタイプと、見出し1および見出し2の下の行を指す矢印があるMarkdownファイルのプレビュー画面

GitHub の概念の紹介

テキストの書式設定

マークダウンファイルの編集画面で、太字と斜体の記法が表示されている

マークダウンファイルのプレビューページの表示で、太字と斜体のテキストが表示されている

GitHub の概念の紹介

ハイパーリンク

マークダウンファイルの編集画面で、ハイパーリンクの記法が表示されている

ハイパーリンク付きのマークダウンファイルのプレビュー画面

GitHub の概念の紹介

ハイパーリンク

ハイパーリンクをクリックする様子を示すアニメーション画面

GitHub の概念の紹介

画像

画像をマークダウンファイルにドラッグし、GitHub が自動的に記法を生成する様子を示すアニメーション画面

GitHub の概念の紹介

READMEの作成

  • 詳細に記述する必要があります
    • 誰でもプロジェクトを理解できるようにする
  • リポジトリの内容を一覧にする
  • 他者にプロジェクトを明確に説明する

開いた本のイラスト

GitHub の概念の紹介

READMEの基本事項

  • タイトル
  • 技術の説明
    • 理由は？
  • プロセスの説明
    • 理由は？
  • 目次
GitHub の概念の紹介

READMEの付属資料

  • プロジェクトがどのように始まったか
  • 動機
  • 制限事項
  • 課題
  • どの問題を解決したいのか
  • 想定される用途は何か
  • クレジット
GitHub の概念の紹介

練習しましょう！

GitHub の概念の紹介

Preparing Video For Download...