Skip to content

Commit 616dddd

Browse files
authored
Clarify documentation
1 parent d0d3a1f commit 616dddd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ Check the [user guide](doc/readme.md) documentation from the `doc/` folder.
2626

2727
## Usage Example
2828

29+
### Setup
30+
After installing the NuGet package, you need to modify your csproj to select a Platform RID via the `RuntimeIdentifier` property:
31+
32+
```xml
33+
<PropertyGroup>
34+
<!-- Workaround for issue https://github.com/microsoft/ClangSharp/issues/129 -->
35+
<RuntimeIdentifier Condition="'$(RuntimeIdentifier)' == '' AND '$(PackAsTool)' != 'true'">$(NETCoreSdkRuntimeIdentifier)</RuntimeIdentifier>
36+
</PropertyGroup>
37+
```
38+
39+
### Code
40+
2941
You can jump-start with the `CppParser.Parse` method:
3042

3143
```C#

0 commit comments

Comments
 (0)