From 87fb6d19a8d06d48840b3d84adae734bb1685997 Mon Sep 17 00:00:00 2001 From: hzhang Date: Fri, 7 Mar 2025 16:31:40 +0000 Subject: [PATCH] add: README --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c14c40 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +Polonium.Sdk + +**Project Description** +Polonium.Sdk bundles Polonium.Tasks, Polonium.Generators, and related tools into a single SDK. By referencing this SDK in your `.csproj`, you can get all Polonium build processes without manually specifying each package. + +**Key Features** +- **One-Stop Integration**: A single `` line grants you the entire Polonium workflow. +- **Version Management**: Automatically references compatible versions of Polonium libraries. +- **Customizable**: You can override default behavior by adding or modifying `.props` and `.targets` in your project. + +**Installation** +1. In your `.csproj`, replace the default SDK with Polonium.Sdk: + ```xml + + + + ``` +2. Alternatively, add the SDK package reference: + ```xml + + ``` +3. Restore packages and build your project. + +4. To keep godot editor from overwriting the sdk, apply Polonium.Godot.Patch + +**Usage Example** +With Polonium.Sdk, you don't need separate references for Polonium.Tasks or Polonium.Generators; everything just works out of the box. + +**License** +This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). +