diff --git a/README.md b/README.md index 351f92b..61c5036 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # Ryujinx.CustomTasks A collection of custom MSBuild tasks. + +## How do I add this Nuget package? + +Make sure to include the package with `PrivateAssets` set to `all`. + +```cs + +``` + +## Tasks + +### GenerateArrays + +This task scans source files for StructArray (i.e. `Array16`) types and generates them. + +#### Input properties: + +- `ArrayNamespace`: Namespace to be used by generated files. + - Required + +- `ArrayOutputPath`: Directory used to save the generated files in. + - Required + +- `ArrayInputFiles`: List of files to be searched for StructArray types. + - Required + - Default: All source files of the current project. + +#### Output properties: + +- `ArrayOutputFiles`: List of files generated by this task.