From df0c194d0633f3a749d2b2a7e8d50bfda33c2847 Mon Sep 17 00:00:00 2001 From: Julien Fischer Date: Tue, 13 Jan 2026 17:30:27 +1100 Subject: [PATCH] Rename a README file. Documentation/README.Docker: Rename -> README.Docker.md. This file was already in Markdown format. Adjust heading levels. Fix a broken link. README.md: Conform to the above change. --- Documentation/{README.Docker => README.Docker.md} | 13 ++++++++----- README.md | 2 +- 2 files changed, 9 insertions(+), 6 deletions(-) rename Documentation/{README.Docker => README.Docker.md} (96%) diff --git a/Documentation/README.Docker b/Documentation/README.Docker.md similarity index 96% rename from Documentation/README.Docker rename to Documentation/README.Docker.md index cdd150107..8a6112605 100644 --- a/Documentation/README.Docker +++ b/Documentation/README.Docker.md @@ -1,7 +1,10 @@ +Mercury in Docker +================= + This file documents using Mercury within a Docker container. Motivation -========== +---------- Docker is a popular way to achieve cross-platform containerisation of applications. Due to the rather lengthy compile time of the Mercury compiler @@ -9,9 +12,9 @@ itself, a way to package the compiler and all of its dependencies is a desirable goal. Building Mercury -================ +---------------- -The [Dockerfile](Dockerfile) is a +The [Dockerfile](../Dockerfile) is a [multi-staged](https://docs.docker.com/develop/develop-images/multistage-build/) Dockerfile. @@ -61,7 +64,7 @@ Additionally building the ROTD tarball is supported via: ``` Using containerised mmc on the host platform -============================================ +-------------------------------------------- ```bash docker run --rm \ @@ -87,7 +90,7 @@ used: ``` Limitations -=========== +---------- Currently only static linkage is supported, as dynamic linkage searches the host for the Mercury runtime library, which might not be installed or not diff --git a/README.md b/README.md index 1ae3ee39e..a3fe16d7c 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Specific information is contained in individual README files in the * Other platform information * [Cross compilation](Documentation/README.cross.md) - * [Docker](Documentation/README.Docker) + * [Docker](Documentation/README.Docker.md) * [x86](Documentation/README.x86.md) ## Other information