unikernel/duniverse/arp/README.md

@@ -0,0 +1,24 @@
+## ARP - Address Resolution Protocol purely in OCaml
+
+v4.1.0
+
+ARP is an implementation of the address resolution protocol (RFC826) purely in
+OCaml.  It handles IPv4 protocol addresses and Ethernet hardware addresses only.
+
+A [MirageOS](https://mirage.io) ARP implementation is in the `mirage` subdirectory.
+
+Motivation for this implementation is [written up](https://hannes.robur.coop/Posts/ARP).
+
+## Documentation
+
+[API documentation](https://mirage.github.io/arp/arp/index.html) is available online.
+
+## Installation
+
+`opam install arp` will install this library, once you have installed OCaml (>=
+4.08.0) and opam (>= 2.0.0).
+
+Benchmarks require more opam libraries, namely `mirage-vnetif mirage-clock-unix
+mirage-unix`.  Use
+`dune build --release bench/bench.exe && _build/default/bench/bench.exe`
+to build and run it.