Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
myd7349 committed Jul 29, 2024
1 parent 41fdd42 commit a184b7a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,21 @@

SharpLSL is a cross-platform C# binding of [**L**ab **S**treaming **L**ayer](https://github.com/sccn/labstreaminglayer).

# Build
# Generate Bindings

Most of the code under the SharpLSL.Interop namespace is generated by ClangSharpPInvokeGenerator.

1. Install [ClangSharpPInvokeGenerator](https://github.com/dotnet/ClangSharp)

```
dotnet tool install --global ClangSharpPInvokeGenerator --version 16.0.0
```

2. Run `generate.bat`
2. Run `Binding/generate.bat`

# Related Projects

- [BlueMuse](https://github.com/kowalej/BlueMuse)
- [labstreaminglayer](https://github.com/sccn/labstreaminglayer)
- [liblsl](https://github.com/sccn/liblsl)
- [liblsl-Csharp](https://github.com/labstreaminglayer/liblsl-Csharp)
Expand Down
2 changes: 2 additions & 0 deletions Source/SharpLSL.Natives/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ The following NuGet packages contain pre-compiled binaries of [liblsl](https://g
[SharpLSL.Native.win-x86-badge]: https://img.shields.io/nuget/v/SharpLSL.Native.win-x86.svg
[SharpLSL.Native.win-x86-nuget]: https://www.nuget.org/packages/SharpLSL.Native.win-x86

During the packaging process, liblsl binary archives are automatically downloaded from the [liblsl-ci-build](https://github.com/myd7349/liblsl-ci-build) release page and then packed into the corresponding NuGet packages named `SharpLSL.Native.[rid]`.

# License

These packages only bundle the dynamic libraries of [liblsl](https://github.com/sccn/liblsl), thus using the same licensing agreement as liblsl. Please refer to the [LICENSE](./LICENSE) file for more information.

0 comments on commit a184b7a

Please sign in to comment.