Skip to content

Commit

Permalink
Clarify documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xoofx authored Feb 27, 2023
1 parent d0d3a1f commit 616dddd
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,18 @@ Check the [user guide](doc/readme.md) documentation from the `doc/` folder.

## Usage Example

### Setup
After installing the NuGet package, you need to modify your csproj to select a Platform RID via the `RuntimeIdentifier` property:

```xml
<PropertyGroup>
<!-- Workaround for issue https://github.com/microsoft/ClangSharp/issues/129 -->
<RuntimeIdentifier Condition="'$(RuntimeIdentifier)' == '' AND '$(PackAsTool)' != 'true'">$(NETCoreSdkRuntimeIdentifier)</RuntimeIdentifier>
</PropertyGroup>
```

### Code

You can jump-start with the `CppParser.Parse` method:

```C#
Expand Down

0 comments on commit 616dddd

Please sign in to comment.