update README.md

.idea/vcs.xml

@@ -2,5 +2,8 @@
 <project version="4">
   <component name="VcsDirectoryMappings">
     <mapping directory="" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/deer-folia-api" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/deer-folia-server" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/paper-api-generator/generated" vcs="Git" />
   </component>
 </project>

README.md

@@ -1,6 +1,9 @@
 # DeerFolia
 
-DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心，它是由 [Mojang](https://mojang.com) 的 Minecraft 服务器核心 [Paper](https://papermc.io) 修改而来。
+DeerFolia 是一个基于 [Folia](https://papermc.io/software/folia) 的 Minecraft
+服务器核心，它是由 [Mojang](https://mojang.com) 的 Minecraft 服务器核心 [Paper](https://papermc.io) 修改而来。
+
+![](https://ssl.lunadeer.cn:14437/i/2024/03/26/660237f7388c3.png)
 
 ## 此分支特性
 
@@ -9,15 +12,13 @@ DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心，它是由 [Mojan
 
 ## 更新上游 Folia 修改
 
-1. 克隆此仓库到本地；
+1. 在终端执行 `./gradlew updateFoliaRef` 更新上游 Folia 修改；
-2. 在终端执行 `./gradlew updateFoliaRef` 更新上游 Folia 修改；
 
 ## 将补丁应用到 Folia 源码
 
 1. 在终端执行 `./gradlew applyPatches` 应用补丁；
 2. 完成后会在项目目录下生成 `deer-folia-server` 和 `deer-folia-api` ，前者即为源码目录;
 
-
 ## 生成服务器核心
 
 1. 应用补丁；
@@ -37,15 +38,18 @@ DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心，它是由 [Mojan
 
 这种方法的工作原理是暂时将 `HEAD` 重置为所需的提交，然后使用 `git rebase` 进行编辑。
 
-> ❗ 在编辑过程中，除非您 *同时* 将对应模块重置为相关提交，否则将无法编译。就 API 而言，您必须重新应用 Server 补丁，如果正在编辑 Server 补丁，则必须重新应用 API 补丁。还要注意的是，这样做时任何一个模块都可能无法编译。这不是一个正常的现象，但这种情况时有发生。请给 Paper 官方提交 ISSUE ！
+> ❗ 在编辑过程中，除非您 *同时* 将对应模块重置为相关提交，否则将无法编译。就 API 而言，您必须重新应用 Server 补丁，如果正在编辑
+> Server 补丁，则必须重新应用 API 补丁。还要注意的是，这样做时任何一个模块都可能无法编译。这不是一个正常的现象，但这种情况时有发生。请给
+> Paper 官方提交 ISSUE ！
 
-1. 在 `deer-folia-server` 或 `deer-folia-api` 目录中执行 `git rebase -i base` ，应该会输出 [这样的](https://gist.github.com/zachbr/21e92993cb99f62ffd7905d7b02f3159) 内容。
+1. 在 `deer-folia-server` 或 `deer-folia-api` 目录中执行 `git rebase -i base`
+   ，应该会输出 [这样的](https://gist.github.com/zachbr/21e92993cb99f62ffd7905d7b02f3159) 内容。
 2. 将你需要修改的补丁由 `pick` 替换为 `edit` 然后保存退出；
-   - 一次只能修改 **一个** 文件！
+    - 一次只能修改 **一个** 文件！
 3. 对你需要修改的补丁作出新的修改；
 4. 使用 `git add .` 添加补丁，再使用 `git commit --amend` 提交；
-   - **确保添加了 `--amend` 选项** 否则将会创建一个新补丁而不是修改原补丁。
+    - **确保添加了 `--amend` 选项** 否则将会创建一个新补丁而不是修改原补丁。
-   - 此处提交时也可以修改补丁信息。
+    - 此处提交时也可以修改补丁信息。
 5. 终端执行 `git rebase --continue` 应用更新；
 6. 再在跟项目目录执行 `./gradlew rebuildPatches` 生成新的补丁；
 
@@ -61,16 +65,16 @@ DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心，它是由 [Mojan
 2. 提交修改（可以不写提交内容）；
 3. 在 `deer-folia-server` 或 `deer-folia-api` 目录中执行 `git rebase -i base` ，将刚才的提交移动到你想要修改的补丁提交下方；
 4. 将新提交的 `pick` 修改为如下内容：
-   - `f`/`fixup`：将你的新修改合并到补丁内，但不改变补丁信息；
+    - `f`/`fixup`：将你的新修改合并到补丁内，但不改变补丁信息；
-   - `s`/`squash`：将你的新修改合并到补丁内，并用新的补丁信息替换原补丁信息；
+    - `s`/`squash`：将你的新修改合并到补丁内，并用新的补丁信息替换原补丁信息；
 5. 在跟项目目录执行 `./gradlew rebuildPatches` 应用补丁更新；
 
 #### 自动
 
 1. 修改相应位置源码；
 2. 提交修改内容 `git commit -a --fixup <要修改的补丁 hash 值>`；
-   - 如果希望更新补丁信息，你可以使用 `--squash` 替换 `--fixup`；
+    - 如果希望更新补丁信息，你可以使用 `--squash` 替换 `--fixup`；
-   - 如果你不知道要修改的补丁 hash 值，你可以使用 `git log` 查看；
+    - 如果你不知道要修改的补丁 hash 值，你可以使用 `git log` 查看；
-   - 如果你只知道补丁的名称，你可以使用 `git log --grep=<补丁名称>` 查看；
+    - 如果你只知道补丁的名称，你可以使用 `git log --grep=<补丁名称>` 查看；
 3. 执行 `git rebase -i --autosquash base` ，这将会自动将你的修改移动到对应的补丁下方；
 4. 在跟项目目录执行 `./gradlew rebuildPatches` 应用补丁更新；