kstack-readme

README を書くときの規約。理由を理解した上で適用すること。package の新設と責務に合わない処理の置き場所は kstack-monorepo、agent 向けの指示の書き方は kstack-agents-md の SKILL を参照。

root README には名前・概要・使い方の入口・license だけを書く

root の README には repository の名前、数行の概要、install と使い方の入口、license を書く。使い方の入口は install の 1 コマンドと最小の例 1 つにし、詳しい手順は app / package の README へのリンクにする。構成表・テスト手順・詳しいセットアップは root に書かず、それを持つ app / package の README に置く。

<!-- Bad: package の中身や手順を root に写している -->

# acme

## 構成

| path          | 内容 |
| ------------- | ---- |
| packages/core | ...  |