add readme

2025-04-25 20:56:49 -04:00
parent 9852f6496a
commit de95a626a0
1 changed files with 15 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,15 @@
+# OC2:R native ICMP module
+
+The Java ICMP functions don't work on some operating systems without admin/root, so a native library is required.
+
+## Platform support:
+
+### Officially supported:
+
+- Windows x86_64 and aarch64
+- Linux x86_64 and aarch64
+- macOS x86_64 and aarch64
+
+### Not officially supported, but should still work:
+
+- Any Linux