diff --git a/.gitignore b/.gitignore index 582f342..04debd3 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,5 @@ riderModule.iml /NuGet.config /Polonium.Tasks.sln.DotSettings.user /VersionInfo.props -.idea/ \ No newline at end of file +.idea/ +/summerizer diff --git a/README.md b/README.md new file mode 100644 index 0000000..5830847 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Polonium.Tasks + +**Project Description** +Polonium.Tasks is a set of MSBuild tasks created to support Godot C# projects using the Polonium library. It streamlines building, cleaning, packaging, and code generation steps by automating operations around scripts, templates, and resources. + +**Key Features** +- **GenerateProxyNodesTask**: Examines source directories and generates script proxies based on `[ProxyNode]` in Polonium, should not be used manually in custom project. +- **GenerateRegistryPassThrough**: Produces bridging files for `[RegistryPassThrough]` attributes in Polonium, should not be used manually in custom project +- **GenerateTextureSetTask**: Helps build and bundle multiple textures (e.g., button states) into a coherent set. +- **Custom Build Workflows**: Extends typical MSBuild processes to manage Godot-specific tasks. + +**Installation** +1. Add the package to your project via `.csproj`: + ```xml + + ``` +2. Restore the packages and build your project. + +**Usage Example** +```xml + + + +``` +When you run a build, these tasks will automatically generate or update relevant files, saving you manual overhead. + +**License** +This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). +