unikernel/duniverse/rresult/README.md

@@ -0,0 +1,44 @@
+Rresult — Result value combinators for OCaml
+-------------------------------------------------------------------------------
+v0.7.0+dune
+
+Rresult is an OCaml module for handling computation results and errors
+in an explicit and declarative manner, without resorting to
+exceptions. It defines combinators to operate on the `result` type
+available from OCaml 4.03 in the standard library.
+
+OCaml 4.08 provides the `Stdlib.Result` module which you should prefer
+to Rresult.
+
+Rresult is distributed under the ISC license.
+
+Home page: http://erratique.ch/software/rresult  
+Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`
+
+## Installation
+
+Rresult can be installed with `opam`:
+
+    opam install rresult
+
+If you don't use `opam` consult the [`opam`](opam) file for build
+instructions.
+
+## Documentation
+
+The documentation and API reference is automatically generated by
+`ocamldoc` from the interfaces. It can be consulted [online][doc]
+
+[doc]: http://erratique.ch/software/rresult/doc/
+
+
+## Sample programs
+
+If you installed Rresult with `opam` sample programs are located in
+the directory `opam config var rresult:doc`.
+
+In the distribution sample programs and tests are located in the
+[`test`](test) directory of the distribution. They can be built and run
+with:
+
+    topkg build --tests true && topkg test