Getting Started

このファイルは、最初のチュートリアルをどう書くかの最小見本です。
テンプレート利用後は、対象技術に合わせて内容を置き換えてください。

概要

このチュートリアルでは、リポジトリ全体の見方と、共通セットアップから学習を始める流れを整理します。
必要であれば、この章に最小構成の確認用コードを置いて、最初の一歩を試せるようにします。

このチュートリアルで学ぶこと

• リポジトリの基本的な見方
• 共通セットアップを確認する流れ
• 最初にどこから読み始めるか

前提条件

• ルート README.md を読めること
• 対象技術の共通セットアップをこれから確認できること

ディレクトリ構成

tutorials/00-getting-started/
├── README.md
└── code/

• README.md: 最初に読む説明を書きます
• code/: 必要であれば最小構成のサンプルを置きます

このチュートリアルで追加で必要な準備

このチュートリアルは、ルート README.md の共通セットアップへ入るための入口として使えます。
通常は、まず共通セットアップを確認すれば進められます。
追加のインストールがある場合だけ、ここに追記してください。

実行方法

このチュートリアルにコードを置く場合は、ここに実行方法を書きます。
コードがない場合は、「この章ではコードの実行はありません」と書いても問題ありません。

例:

cd tutorials/00-getting-started/code

コードの解説

コードを置いた場合は、「何を確認するためのコードか」を短く説明します。
最初の章では、複雑な実装よりも「ちゃんと動くことを確認する」ことを優先すると進めやすいです。

次に進む準備

ここまでで、リポジトリの見方と最初の進め方が分かりました。
次は tutorials/01-core-concepts/ で基本概念を確認します。

まとめ

• 最初にルート README.md を読み、全体の構成と共通セットアップを確認します。
• 各チュートリアルでは、共通セットアップを繰り返さず、その章だけで必要な準備と実行方法を書きます。
• 学習順序に迷ったら docs/roadmap.md を確認し、用語でつまずいたら docs/glossary.md を見直します。