From 74c7cd4de65f29423bf5e675e6e30422b1adda79 Mon Sep 17 00:00:00 2001
From: hzhang <hzhang@hangman-lab.top>
Date: Fri, 7 Mar 2025 16:31:40 +0000
Subject: [PATCH] add: README

---
 .gitignore |  2 ++
 README.md  | 31 +++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 597439f..9f4363e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,3 +4,5 @@ obj/
 riderModule.iml
 /_ReSharper.Caches/
 /VersionInfo.props
+/summerizer
+/NuGet.config
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..391c050
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Polonium.Godot.Patcher
+
+**Project Description**  
+Polonium.Godot.Patcher is a specialized tool designed for Godot C# projects, focusing on modifying or patching certain assemblies to preserve your custom .NET SDK configurations. At present, its core functionality is to patch the `GodotTools.ProjectEditor.dll` within the Godot Editor’s `GodotSharp/Tools` directory. This ensures that the editor does not override your C# project’s SDK settings.
+
+**Key Feature**
+- **Patch for `GodotTools.ProjectEditor.dll`**: Prevents the Godot editor from rewriting the project SDK, giving you more control over your build environment.
+
+**Installation**
+1. Obtain `Polonium.Godot.Patcher` from this repository or through a package feed.
+
+**Build**
+```bash
+dotnet build Polonium.Godot.Patcher.csproj
+chmod +x ./publish
+./publish
+```
+This produces an AppImage or other executable depending on your configuration.
+
+**Usage**
+1. Locate the `GodotTools.ProjectEditor.dll` file in your Godot installation (usually under `GodotSharp/Tools`).
+2. Place the resulting AppImage (or binary) in the same directory as `GodotTools.ProjectEditor.dll`.
+3. Run the patcher in a terminal:
+```bash
+./PoloniumGodotPatcher.AppImage
+```
+Upon execution, the patcher modifies `GodotTools.ProjectEditor.dll` to prevent the editor from altering your C# project SDK settings.
+
+**License**  
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+