Chg: README

README.md

@@ -1,16 +1,46 @@
 # uwuzu for Docker Compose
 uwuzuがDocker Composeで動きます。  
-※一部バージョンでは動かない可能性があります。動作保証は致しません。また、セキュリティ上の問題が発生する可能性があるため本番環境では推奨しません。
+※1: 一部バージョンでは動かない可能性があります。
+※2: 動作保証は致しません。
+※3: セキュリティ上の問題が発生する可能性があるため本番環境では推奨しません。
 
-# 使い方
+# 構造
 ## /.env
 .env.exampleのコメントに従って入力してください。
 
-## /src
+## /src/
 srcフォルダにuwuzuのリポジトリで配布されているZIPファイルを展開してください。
 
-## /db・/php
+## /db/・/php/
 設定ファイルやDockerfileなどがあります。  
 動作しない場合は適宜修正してください。
-> [!NOTE]
+余裕があればIssue・プルリクエストのご協力をお願いします。
-> 余裕があればIssue・プルリクエストのご協力をお願いします。
+
+# 前提条件
+## 必須
+Docker Composeが必要です。  
+※Windows containersは利用できません。
+## 動作確認済み
+OS: Windows 11 23H2
+WSLカーネル: 2.6.1.0
+Docker Compose: v2.40.2-desktop.1
+uwuzu:
+  - v1.6.0
+
+# 使い方
+0. `/.env.example`のコメントに従って`/.env`を作成。
+1. `/src/`以下にuwuzuのリポジトリで配布されているZIPファイルを展開。
+2. `/php/apache2.conf`を適宜変更。
+3. プロジェクトルートで`docker-compose build --no-cache`を実行。
+4. `docker-compose up`でuwuzu及びMariaDBが起動します。
+5. `/admin`に移動し初期設定を行います。
+6. uwuzuの表示に従って初期設定を進めます。
+   データベース名には`uwuzu`、ホストには`uwuzu-db`を使用してください。
+   ※`db.php`の書き込みが成功しても移動しない場合は`/admin/setup_uwuzu_db.php`に直接移動してください。
+7. これにてuwuzuの構築は完了です。
+
+今後uwuzuの破壊的変更により`/db/`や`/php/`の設定が利用できなくなる可能性があります。  
+その場合はIssueを立てuwuzuのバージョンアップを報告するか対応を待機、あるいは自身で設定を変更してください。  
+(余裕があれば動作した設定をプルリクエストするご協力をお願いします。)
+
+問題が発生した場合はIssueを立ててください。