Skip to content

Commit c99a525

Browse files
MikhailGorobetsTheMostDiligent
authored andcommitted
Added documentation for building .NET project
1 parent e28a293 commit c99a525

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ The module's cmake script defines a number of variables that are required to gen
4545
- [Binding Shader Resources](#binding_resources)
4646
- [Setting the Pipeline State and Invoking Draw Command](#draw_command)
4747
- [Low-level API interoperability](#low_level_api_interoperability)
48+
- [NuGet package build instructions](#nuget_build_instructions)
4849
- [License](#license)
4950
- [Contributing](#contributing)
5051
- [Release History](#release_history)
@@ -696,6 +697,39 @@ objects. Refer to the following pages for more information:
696697
[Vulkan Interoperability](https://github.com/DiligentGraphics/DiligentCore/tree/master/Graphics/GraphicsEngineVulkan#interoperability-with-vulkan)
697698

698699

700+
<a name="nuget_build_instructions"></a>
701+
# NuGet Package Build Instructions
702+
703+
Follow the following steps to build the NuGet package:
704+
705+
1. Install the required Python packages
706+
707+
708+
```
709+
python -m pip install -r ./BuildTools/.NET/requirements.txt
710+
```
711+
712+
2. Run the NuGet package build script, for example:
713+
714+
715+
```
716+
python ./BuildTools/.NET/dotnet-build-package.py -c Debug -d ./
717+
```
718+
719+
## Command Line Arguments
720+
721+
| Argument | Description | Required |
722+
|----------------------------|---------------------------------------------------------------------------------|---------------------|
723+
| `-c` (`configuration`) | Native dynamic libraries build configuration (e.g. Debug, Release, etc.) | Yes |
724+
| `-d` (`root-dir`) | The path to the root directory of DiligentCore | Yes |
725+
| `-s` (`settings`) | The path to the settings file | No |
726+
| `dotnet-tests` | Flag indicating whether to run .NET tests | No |
727+
| `dotnet-publish` | Flag indicating whether to publish the package to NuGet Gallery | No |
728+
| `free-memory` | Use this argument if you encounter insufficient memory during the build process | No |
729+
730+
You can override the default settings using a settings file
731+
(check the `default_settings` dictionary in `dotnet-build-package.py`)
732+
699733
<a name="license"></a>
700734
# License
701735

0 commit comments

Comments
 (0)