add docs

README.md

@@ -1 +1,36 @@
 # madamis
+
+## 身内向けマダミスシナリオ管理アプリ
+
+- マダミスシナリオの情報を管理します
+- 試合情報を追加することで、追加プレイ可能かどうかも確認できます
+
+### ScreenShots
+
+- 一覧画面
+
+![index](./docs/assets/index.png)
+
+- ダークモード対応
+
+![index_dark](./docs/assets/index_dark.png)
+
+- シナリオ追加画面
+
+![add_madamis](./docs/assets/add_madamis.png)
+
+- 試合追加画面
+
+![add_game](./docs/assets/add_game.png)
+
+- 同じシナリオで2回目を遊ぶ場合は、1回目の試合のPLは選択肢から除外されます
+
+![add_game_2](./docs/assets/add_game_2.png)
+
+- 未プレイ(試合情報なし)、遊ぶ人数でのフィルタリングができます
+
+![filter](./docs/assets/filter.png)
+
+### Resource
+
+[Developing](./docs/Develop.md)

docs/Develop.md

@@ -0,0 +1,54 @@
+# madamis
+
+## How To Develop
+
+### 0 Prepare Node
+
+Prepare Node Environment
+
+e.g. https://nodejs.org/ https://volta.sh/
+
+Linux(Ubuntu) installation using volta
+
+```sh
+curl https://get.volta.sh | bash
+
+volta install node
+
+volta install corepack
+
+corepack enable
+```
+
+### 1 Install Dependencies
+
+```sh
+pnpm i
+```
+
+- If asked to download pnpm, do so.
+
+### 2 Prepare DB
+
+To prepare the database, run the migrations
+
+```sh
+pnpm migrate
+```
+
+There is no data in the Users table, so add it  
+(Data can be freely entered)
+
+```sh
+pnpx wrangler d1 execute madamis-db --local --command "INSERT INTO Users (name, color) VALUES ('User1', '#1b7a16'), ('User2', '#bd8317');"
+```
+
+### 3 Run App
+
+To run the App, run this command
+
+```sh
+pnpm dev
+```
+
+Then, you can access the App in your browser