From c0ba63117980d0afb4e1882f7c2f3073c932b81f Mon Sep 17 00:00:00 2001 From: StevenWdV Date: Thu, 25 Nov 2021 15:22:42 +0100 Subject: Add Python README.md, improve other READMEs --- README.md | 4 ---- wrappers/csharp/README.md | 5 +---- wrappers/python/README.md | 9 +++++++++ 3 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 wrappers/python/README.md diff --git a/README.md b/README.md index b1712f3..be7c609 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,11 @@ be downloaded by the caller. ## Build & test Build shared library for current platform: - ```shell make ``` Build shared library for specified OS & architecture (example): - ```shell make OS=windows ARCH=386 ``` @@ -28,13 +26,11 @@ make OS=windows ARCH=386 Results will be output in `exports/`. Test Go code: - ```shell make test-go ``` Test wrappers: - ```shell make test-wrappers ``` diff --git a/wrappers/csharp/README.md b/wrappers/csharp/README.md index a00922a..4b045ac 100644 --- a/wrappers/csharp/README.md +++ b/wrappers/csharp/README.md @@ -1,24 +1,21 @@ 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 -methods [here](https://stackoverflow.com/q/43400069) or [here](https://stackoverflow.com/q/10240029) it automatically +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/README.md b/wrappers/python/README.md new file mode 100644 index 0000000..f10e5ad --- /dev/null +++ b/wrappers/python/README.md @@ -0,0 +1,9 @@ +First build the shared Go library. Next: + +No dependencies, just reference `discovery.py` and call `verify`. + +Test: + +```shell +make test +``` -- cgit v1.2.3