Add GenerateArrays overview to README.md
This commit is contained in:
parent
98600536a2
commit
f82f22f96a
1 changed files with 30 additions and 0 deletions
30
README.md
30
README.md
|
@ -1,3 +1,33 @@
|
||||||
# Ryujinx.CustomTasks
|
# Ryujinx.CustomTasks
|
||||||
|
|
||||||
A collection of custom MSBuild tasks.
|
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.
|
||||||
|
|
Loading…
Reference in a new issue