From 51c45df8c4ffa2dc3ac0e1cb050438ec4ab395dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20CORTIER?= Date: Tue, 25 Mar 2025 06:46:04 +0900 Subject: [PATCH] docs(ffi): document how to build the .NET bindings --- ffi/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 ffi/README.md diff --git a/ffi/README.md b/ffi/README.md new file mode 100644 index 00000000..9e7cecf1 --- /dev/null +++ b/ffi/README.md @@ -0,0 +1,21 @@ +# IronRDP FFI + +[Diplomat]-based FFI for IronRDP. + +Currently, only the .NET target is officially supported. + +## How to build + +- Install required tools: `cargo xtask ffi install` + - For .NET, note that `dotnet` is also a requirement that you will need to install on your own. + +- Build the shared library: `cargo xtask ffi build` (alternatively, in release mode: `cargo xtask ffi build --release`) + +- Build the bindings: `cargo xtask ffi bindings` + +At this point, you may build and run the examples for .NET: + +- `dotnet run --project Devolutions.IronRdp.ConnectExample` +- `dotnet run --project Devolutions.IronRdp.AvaloniaExample` + +[Diplomat]: https://github.com/rust-diplomat/diplomat