Skip to content

Instantly share code, notes, and snippets.

@dev-satoshi
Last active August 31, 2024 07:14
Show Gist options
  • Save dev-satoshi/e362c790eb5f6b64e35ed5db6155ea1d to your computer and use it in GitHub Desktop.
Save dev-satoshi/e362c790eb5f6b64e35ed5db6155ea1d to your computer and use it in GitHub Desktop.
READMEのテンプレート

Product Name

DEMO

Slide

Features

Tech Stack

System Configuration

Directory Structure

Requirements

Installation

Getting Started

Authors

license

@dev-satoshi
Copy link
Author

dev-satoshi commented Mar 30, 2024

モノリスで大規模な開発になった場合、frontend、backend...などに関するドキュメントはdocsディレクトリで整理した方が良い気がする
ルートREADME.mdからdocsに誘導した方が良い

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment