From 8c0a0415dea456ddb718980c81e847a7d96a3b8e Mon Sep 17 00:00:00 2001 From: Ives van Hoorne Date: Wed, 16 Mar 2022 18:49:28 +0100 Subject: [PATCH] update README.md to show commands in code blocks (#4932) --- README.md | 43 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 35 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 55d9b435..51f70638 100644 --- a/README.md +++ b/README.md @@ -128,14 +128,41 @@ For collaboration, you will need to set up [collab server](https://github.com/ex #### Commands -| Command | Description | -| ------------------ | --------------------------------- | -| `yarn` | Install the dependencies | -| `yarn start` | Run the project | -| `yarn fix` | Reformat all files with Prettier | -| `yarn test` | Run tests | -| `yarn test:update` | Update test snapshots | -| `yarn test:code` | Test for formatting with Prettier | +##### Install the dependencies + +``` +yarn +``` + +##### Run the project + +``` +yarn start +``` + +##### Reformat all files with Prettier + +``` +yarn fix +``` + +##### Run tests + +``` +yarn test +``` + +##### Update test snapshots + +``` +yarn test:update +``` + +##### Test for formatting with Prettier + +``` +yarn test:code +``` #### Docker Compose