Merge 32b8d91 into 611dcfc

README.md

@@ -40,6 +40,36 @@
 
 This library implements Multi-Party Computation (MPC) using the milargo crypto library.
 
+# Building and running libmpc with Docker (preferred)
+
+The preferred way to get libmpc built and tested is through the use of docker. To do so, you should install docker and ensure it runs fine:
+```
+docker run hello-world
+```
+in case you run in permission errors, on some Linux platforms you might need to add your user to the docker group:
+```
+sudo gpasswd -a <youruser> docker
+```
+
+Once your docker installation is correctly set-up, simply run
+```sh
+docker build -t libmpc .
+```
+to run tests and ensure all routines perform as expected, run:
+```sh
+docker run --cap-add SYS_PTRACE --rm libmpc
+```
+
+Note that all of the above commands will by default generate an image native to your platform. In case you wish to build and run code for a different platform, use the `--platform linux/amd64` or `--platform linux/arm64` switches (paying a performance hit).
+
+Once this works, you can use this Dockerfile as a basis to build your own recipes. We will eventually publish an official OCI image on a registry, if there is sufficient demand (open an issue please).
+
+This procedure has been tested on all major platforms (Linux, Mac OS, Windows) on arm64 and x86_64 platforms. If your build or execution fails, please open a bug.
+
+# Building natively
+
+Sometimes, you will need to build and run libmpc natively. Here's how you do that:
+
 ## Dependencies
 
 In order to build this library, the following packages are required: