summaryrefslogtreecommitdiff
path: root/wrappers/java/README.md
diff options
context:
space:
mode:
authorStevenWdV <stevenwdv@gmail.com>2021-11-29 00:12:42 +0100
committerStevenWdV <stevenwdv@gmail.com>2021-11-29 00:12:42 +0100
commitf463d4c1a550c4b3dfc0be362f0b0a723a88122d (patch)
tree9b85337f1d9eda3d7070cd57d952712cfe2ae6cc /wrappers/java/README.md
parent60658378f68cc7c67cbea2758c6aef455c115c05 (diff)
Improve Java wrapper: add all tests, link correct libraries, use Maven, add Makefile & GitHub workflow. Fix make clean targets.
Diffstat (limited to 'wrappers/java/README.md')
-rw-r--r--wrappers/java/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/wrappers/java/README.md b/wrappers/java/README.md
new file mode 100644
index 0000000..87cdd49
--- /dev/null
+++ b/wrappers/java/README.md
@@ -0,0 +1,31 @@
+# Java wrapper
+
+## Requirements
+
+You will need to install JDK 8 or later ([Adoptium](https://adoptium.net/)
+or [Oracle](https://www.oracle.com/java/technologies/downloads/)). To easily compile the project, you should
+download [Maven](https://maven.apache.org/).
+
+## Build & test
+
+First build the shared Go library. Next:
+
+Build `EduVpnCommon`:
+
+```shell
+make
+```
+
+Build as JAR, including eduvpn_verify library:
+
+```shell
+make pack
+```
+
+The JAR will include all versions of the library that are built in the `exports` folder.
+
+Test:
+
+```shell
+make test
+```