Update README.md

This commit is contained in:
Benjamin Höglinger-Stelzer 2024-09-07 22:10:06 +02:00
parent 842836551b
commit 06299dd7f1

View File

@ -35,7 +35,7 @@ Built for and tested on **Windows 10 version 1507 (or newer) x64/ARM64**. 32-Bit
- Add the `include` directory to your project's headers search path. - Add the `include` directory to your project's headers search path.
- To make your life easier I recommend setting an environment variable named `DOMITO_INC_PATH` to `...\Domito\include` absolute path and... - To make your life easier I recommend setting an environment variable named `DOMITO_INC_PATH` to `...\Domito\include` absolute path and...
- ...in your project add `$(DOMITO_INC_PATH);` to "Additional Include Directories". - ...in your project add `$(DOMITO_INC_PATH);` to "Additional Include Directories".
- Add includes (preferably in the provided order): - Add includes (preferably in the provided order):
```c ```c
#include <ntddk.h> #include <ntddk.h>
#include <ntimage.h> #include <ntimage.h>
@ -43,6 +43,9 @@ Built for and tested on **Windows 10 version 1507 (or newer) x64/ARM64**. 32-Bit
#include <Domito.h> #include <Domito.h>
``` ```
- Call `DomitoInit()` in your `DriverEntry` once to bootstrap internals. - Call `DomitoInit()` in your `DriverEntry` once to bootstrap internals.
### Manual linker settings
- Link against the resulting `Domito.lib` file for your desired architecture. - Link against the resulting `Domito.lib` file for your desired architecture.
- To make your life easier I recommend setting an environment variable named `DOMITO_LIB_PATH` to `...\Domito\lib` absolute path and... - To make your life easier I recommend setting an environment variable named `DOMITO_LIB_PATH` to `...\Domito\lib` absolute path and...
- ...in your project add `$(DOMITO_LIB_PATH)\$(DDKPlatform)\$(Configuration)\Domito.lib;$(DOMITO_LIB_PATH)\$(DDKPlatform)\ci.lib;` to "Additional Dependencies". - ...in your project add `$(DOMITO_LIB_PATH)\$(DDKPlatform)\$(Configuration)\Domito.lib;$(DOMITO_LIB_PATH)\$(DDKPlatform)\ci.lib;` to "Additional Dependencies".
@ -50,6 +53,24 @@ Built for and tested on **Windows 10 version 1507 (or newer) x64/ARM64**. 32-Bit
- Link against `cng.lib` for the CNG BCrypt APIs. - Link against `cng.lib` for the CNG BCrypt APIs.
- Done! - Done!
### Using the property sheet
Copy the provided `Domito.props` file into the directory of your `.vcxproj` file and customize it like below:
```xml
<!-- The rest of the project file -->
<ImportGroup Label="PropertySheets">
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
</ImportGroup>
<!-- Create or update the following section below the above snippet -->
<ImportGroup Label="PropertySheets">
<!-- potential other custom sheet references -->
<!-- Reference "Domito.props" here -->
<Import Project="Domito.props" />
</ImportGroup>
<!-- The rest of the project file -->
```
## Sources & 3rd party credits ## Sources & 3rd party credits
This library benefits from these awesome projects ❤ (appearance in no special order): This library benefits from these awesome projects ❤ (appearance in no special order):