From cf0cbb03bf8187c1379c17345c4c215b9e5aebf4 Mon Sep 17 00:00:00 2001
From: Satoshi Yasuda <yasuda@fixpoint.co.jp>
Date: Wed, 10 Apr 2024 11:15:23 +0900
Subject: [PATCH] add README.md

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..2d4d15407b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+公式の [guacd](https://github.com/apache/guacamole-server) のリポジトリのフォークです
+
+オリジナルの README は[こちら](./README)
+
+## ブランチ運用について
+
+Kroker 用のソースコードは [`fixpoint`](https://github.com/fixpoint/guacamole-server/tree/fixpoint) ブランチにあります
+
+### 変更時
+
+変更の際は `fixpoint` ブランチから分岐させて PR  を作成してください
+
+### バージョンアップ
+
+ベースになる guacd のバージョンを更新する場合は、`fixpoint` ブランチに対象のバージョンタグをマージしてください
+
+```
+$ git switch fixpiont
+$ git merge X.Y.Z
+```
+
+バージョン番号などコンフリクトが発生するので適宜解消してください
+
+### リリース時
+
+リリース時には `fixpoint` ブランチ上にタグを切ってください
+タグには、ベースとなった公式のバージョンタグに `-fp.{INDEX}` を追加した名前を使用します
+
+例えば、公式のバージョンタグが `1.5.3` なら、最初のリリースタグは `1.5.3-fp.0` とし、その後は `1.5.3-fp.1`, `1.5.3-fp.2` ... となります
+また、公式のバージョンを `1.5.4` に上げたなら、また `1.5.4-fp.0` から始めます
+
+---
+
+```mermaid
+%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateTagLabel': true, 'showCommitLabel': false}} }%%
+gitGraph LR:
+    commit tag: "vX.X.X"
+    branch fixpoint
+    commit tag: "vX.X.X-fp.0"
+    commit
+    commit tag: "vX.X.X-fp.1"
+    checkout main
+    commit tag: "vX.X.Y"
+    checkout fixpoint
+    merge main tag: "vX.X.Y-fp.0"
+   commit
+    commit tag: "vX.X.Y-fp.1"
+    checkout main
+    commit tag: "vX.X.Z"
+```
+