ryujinx/Ryujinx.CustomTasks
1
0
Fork 0
mirror of https://github.com/Ryujinx/Ryujinx.CustomTasks.git synced 2024-12-22 14:05:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add GenerateArrays overview to README.md

Browse source
This commit is contained in:
TSR Berry 2022-12-15 17:00:02 +01:00
parent 98600536a2
commit f82f22f96a
No known key found for this signature in database
GPG key ID: 52353C0A4CCA15E2
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -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
<PackageReference Include="Ryujinx.CustomTasks" Version="1.0.0" PrivateAssets="all" />
```
## Tasks
### GenerateArrays
This task scans source files for StructArray (i.e. `Array16<byte>`) 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.