From 770a9312f022cace506dec149f171e0dd37d81d0 Mon Sep 17 00:00:00 2001 From: Chris Crone Date: Tue, 1 Sep 2020 10:04:01 +0200 Subject: [PATCH] readme: Minor fixes Signed-off-by: Chris Crone --- BUILDING.MD => BUILDING.md | 0 README.md | 13 ++++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) rename BUILDING.MD => BUILDING.md (100%) diff --git a/BUILDING.MD b/BUILDING.md similarity index 100% rename from BUILDING.MD rename to BUILDING.md diff --git a/README.md b/README.md index fd4f1d33..f6016e9a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ using the Docker commands you already know. To get started, all you need is: * An [AWS](https://aws.amazon.com) or [Azure](https://azure.microsoft.com) account -* Windows: Edge release of +* Windows: The Edge release of [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows) * macOS: The Edge release of [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac) @@ -27,9 +27,12 @@ To get started, all you need is: * ECS: [Deploying Wordpress to the cloud](https://www.docker.com/blog/deploying-wordpress-to-the-cloud/) * ACI: [Deploying a Minecraft server to the cloud](https://www.docker.com/blog/deploying-a-minecraft-docker-server-to-the-cloud/) -## Developing - -See [Instructions](BUILDING.MD) on building the cli, running tests locally and against Azure Container Instances (ACI) or Amazon ECS, and releasing it. -Also Check [contribution guidelines](CONTRIBUTING.md) on conventions used in this project. +## Development +See the instructions in [BUILDING.md](BUILDING.md) for how to build the CLI and +run its tests; including the end to end tests for local containers, ACI, and +ECS. +The guide also includes instructions for releasing the CLI. +Before contributing, please read the [contribution guidelines](CONTRIBUTING.md) +which includes conventions used in this project.