diff options
| author | StevenWdV <stevenwdv@gmail.com> | 2021-11-26 18:14:49 +0100 |
|---|---|---|
| committer | StevenWdV <stevenwdv@gmail.com> | 2021-11-26 18:14:49 +0100 |
| commit | c5c71a584b5e5fd2fdf59477ea7ec1e4ddddda25 (patch) | |
| tree | 3a1b28e68365c45a3a9be38e7432529898e96d80 /wrappers | |
| parent | 96dca850f8e80ae7608a008dbbe4e76df4991ca0 (diff) | |
Add requirements & MinGW instructions to READMEs. Change OS/ARCH to GOOS/GOARCH. Add build step to Python test Makefile.
Diffstat (limited to 'wrappers')
| -rw-r--r-- | wrappers/csharp/README.md | 20 | ||||
| -rw-r--r-- | wrappers/python/Makefile | 1 | ||||
| -rw-r--r-- | wrappers/python/README.md | 8 |
3 files changed, 27 insertions, 2 deletions
diff --git a/wrappers/csharp/README.md b/wrappers/csharp/README.md index 4b045ac..d4d1d97 100644 --- a/wrappers/csharp/README.md +++ b/wrappers/csharp/README.md @@ -1,21 +1,37 @@ +# C# wrapper + +## Requirements + +You will need to install the [.NET SDK](https://dotnet.microsoft.com/download), which includes the `dotnet` tool. The +wrapper targets .NET Standard 2.0, so which means that at least .NET Core 2.0 is required (.NET 5+ is also fine). For +the tests, .NET 5 or newer is required. + +## Build & test + First build the shared Go library. Next: Build `EduVpnCommon`: + ```shell make ``` Build as nupkg, including eduvpn_verify library: + ```shell make pack ``` -Currently, directly referencing the project may not work if you have multiple dynamic libraries compiled in -the `exports` folder. If you instead add the `.nupkg`, e.g. with one of the +The wrapper targets .NET Standard 2.0, which means that it can be referenced by projects using either .NET Framework +4.6.1+, .NET Core 2.0+, or .NET 5+. + +Currently, directly referencing the project may not work (with `System.BadImageFormatException`) if you have multiple +dynamic libraries compiled in the `exports` folder. If you instead add the `.nupkg`, e.g. with one of the methods [here](https://stackoverflow.com/q/43400069) or [here](https://stackoverflow.com/q/10240029), it automatically copies the correct library. Test: + ```shell make test ``` diff --git a/wrappers/python/Makefile b/wrappers/python/Makefile index 162b043..77c620e 100644 --- a/wrappers/python/Makefile +++ b/wrappers/python/Makefile @@ -4,4 +4,5 @@ compile: python3 -m discovery test: + $(MAKE) -C ../../exports python3 -m unittest test_discovery diff --git a/wrappers/python/README.md b/wrappers/python/README.md index f10e5ad..fddcde6 100644 --- a/wrappers/python/README.md +++ b/wrappers/python/README.md @@ -1,3 +1,11 @@ +# Python wrapper + +## Requirements + +Python 3.6+ is assumed, but it may work with older versions. + +## Test + First build the shared Go library. Next: No dependencies, just reference `discovery.py` and call `verify`. |
